인생은 파도타기

  • 홈
  • 태그
  • 방명록

api document 1

API 문서 만들기 - OpenAPI 3.0 적용하기

OpenAPI 란? OpenAPI Specification 3.0 ( OAS ) 라고도 하며 이전 2.0버전까지는 Swagger 라는 도구로 더 유명하다. 아직까지도 Swagger (스웨거) 3 라거나 하는 경우도 종종 있는거같다. OpenAPI 는 RESTFul API를 명세화하거나 문서화 하기 위한 도구로 개발되었으며, 최소한의 구현으로 한눈에 API에 필요한 내용을 파악하기 위해 만들어지고 사용되고 있다. 즉, API를 문서화하기 위한 도구 라고 이해하는 것이 맞다. 그렇다면 왜 이런 도구가 필요해진걸까? 조금만 생각해보자면 현업에서 다양한 사람들과, 여러 클라이언트들에게 내가 혹은 우리회사가 만든 api 를 제공하거나 개발해야하는 경우가 많다. 이때, 이 api를 한눈에 보여주고 필요한 사항을 요..

Programming/Spring 2022.08.31
이전
1
다음
더보기
프로필사진

개발자의 웹서핑, 기술 블로그

  • 생각하기 (96)
    • Hobby (1)
    • Study (4)
      • 가상 면접 사례로 배우는 대규모 시스템 설계 기초 (1)
      • Redis (2)
    • Living (4)
    • Programming (6)
      • JAVA (16)
      • Kotlin (2)
      • Spring (15)
      • Project (2)
      • GO (3)
      • JavaScript (2)
      • CondingTest (14)
      • Computer Science (16)
      • Linux (3)
      • Docker (4)
      • Database (2)

최근글과 인기글

  • 최근글
  • 인기글

Calendar

«   2025/05   »
일 월 화 수 목 금 토
1 2 3
4 5 6 7 8 9 10
11 12 13 14 15 16 17
18 19 20 21 22 23 24
25 26 27 28 29 30 31

방문자수Total

  • Today :
  • Yesterday :

Copyright © Kakao Corp. All rights reserved.

티스토리툴바