길민호(ethan.mino)
코딩수첩
길민호(ethan.mino)
전체 방문자
오늘
어제
  • 분류 전체보기 (215)
    • Computer Science (0)
    • Web (6)
      • CSS (0)
      • HTML (0)
    • Node.js (0)
    • Javascript (2)
    • Java (46)
      • Spring (27)
      • Jsp (0)
    • C\C++ (2)
    • Programming (0)
    • AI (0)
    • Database (7)
    • Git (5)
    • Algorithm (119)
      • Stack (0)
      • Queue (0)
      • Linked List (0)
      • Sort (0)
      • Simulation (27)
      • Recursion (0)
      • Backtracking (4)
      • Two Pointer (3)
      • Dynamic Programming (19)
      • Greedy (10)
      • Graph (3)
      • Dijkstra (1)
      • BFS\DFS (8)
      • Floyd (1)
      • MST (4)
      • Tree (4)
      • Binary Search (8)
      • Binary Search Tree (4)
    • IntelliJ (4)
    • Vscode (0)
    • Operating System (0)
    • 후기 (3)
    • 성장일지 (13)
    • 스터디 (7)
    • 설치 (1)

블로그 메뉴

  • 홈
  • 태그
  • 방명록

공지사항

인기 글

태그

  • ㅡ

최근 댓글

최근 글

티스토리

hELLO · Designed By 정상우.
길민호(ethan.mino)

코딩수첩

Java/Spring

스웨거 (Swagger)란?

2020. 7. 1. 22:53

스웨거 (Swagger)란?

  • 스웨거는 Web API 문서화를 위한 도구이다.
  • 스웨거 홈페이지에서는 스웨거를 OAS(Open API Specification)이라고 소개하고 있다.
  • 말 그대로 API들이 가지는 명세(Spec)을 관리하기 위한 프로젝트이다.
  • Web API를 수동으로 문서화 하는 것은 굉장히 힘든일인데, Web API의 스펙이 변경되었을 때 문서 역시 변경되어야 하는데 이를 유지하는 것이 쉽지 않다.
  • Swagger를 사용하면 Web API가 수정되더라도 문서가 자동으로 갱신 되기 때문에 편리하다.

 

스웨거의 기능

스웨거 홈페이지를 가보면 아래와 같은 기능이 있다.

  • API Design
  • API Development
  • API Testing
  • API Mocking and Virtualization
  • API Governance
  • API Monitoring
  • OpenAPI & Swagger

Web API를 이용하는 개발자가 Web API가 만들어질 때까지 기다린다면 작업이 상당히 느려질 수 있다. Web API를 만드는 개발자와 Web API를 사용하는 사람 간에 미리 명세를 정의하고 공유할 수 있다면 개발이 상당히 편리해질 것이다. 이러한 것들을 편리하게 해주는 도구 중에 하나가 "스웨거"이다.

 

스웨거 허브를 이용하여 API를 명세화하고 테스트하기

스웨거 허브 사이트를 이용하면 Web API를 만들지 않더라도 Web API를 명세화 할 수 있다. 또한 Web API를 명세화 하는것 뿐 아니라 간단히 테스트도 할 수 있다는 장점이 있다.

 

 

참조 URL

  • https://www.edwith.org/boostcourse-web-be/lecture/58988/

'Java > Spring' 카테고리의 다른 글

pom.xml  (0) 2020.07.11
Maven이란?  (0) 2020.07.10
Rest Controller란?  (0) 2020.07.01
Post 방식으로 데이터 전송시 한글이 깨지는 문제  (0) 2020.06.30
Spring Error  (0) 2020.06.30
    'Java/Spring' 카테고리의 다른 글
    • pom.xml
    • Maven이란?
    • Rest Controller란?
    • Post 방식으로 데이터 전송시 한글이 깨지는 문제
    길민호(ethan.mino)
    길민호(ethan.mino)
    💻 호기심 많은 서버 개발자 길민호입니다.

    티스토리툴바