Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

0. swagger에 대한 조사 #3

Open
hoyyChoi opened this issue Aug 30, 2022 · 0 comments
Open

0. swagger에 대한 조사 #3

hoyyChoi opened this issue Aug 30, 2022 · 0 comments
Labels
조사 Improvements or additions to documentation

Comments

@hoyyChoi
Copy link
Member

hoyyChoi commented Aug 30, 2022

swagger

  • 개발한 Rest API를 편리하게 문서화 해주는 도구, 이를 통해 관리 및 제 3의 사용자가 프로젝트의 api 목록을 웹에서 확인 및 테스트 가능하게 하는 라이브러리

특징

  • open api specification(oas)를 위한 프레임워크이다.
  • api들이 가지고 있는 스펙(정보, 회원정보, 데이터 등)을 명세 관리할 수 있다.
  • api 사용방법을 사용자에게 알려주는 문서이다.
  • Swagger를 사용하면 Web API가 수정되더라도 문서가 자동으로 갱신 되기 때문에 편리하다.
  • swgger 하나만으로 서버개발자, 클라이언트개발자가 api상호작용을 할 수 있다.
  • 문서 출처

RealWorld swagger

RealWorld swagger

@hoyyChoi hoyyChoi changed the title swagger swagger에 대한 조사 Aug 30, 2022
@1013115 1013115 changed the title swagger에 대한 조사 0. swagger에 대한 조사 Sep 3, 2022
@1013115 1013115 added the 조사 Improvements or additions to documentation label Sep 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
조사 Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants