swagger OpenAPI 3.0 가이드

Metadata 👉opneapi 모든 API 정의에는 OpenAPI Specification 버전이 포함되어야 합니다. OpenAPI 버전은 API 정의의 전체적인 구조를 정의할 수 있습니다. OpenAPI 은 semativ versioning을 따릅니다.

모든 API 엔드포인트는 base URL(server URL)의 상대경로다.OpenAPI3.0에서는 API에 대한 여러 base URL들을 배열로 명시할 수 있다.servers의 각 server는 url prefix를 반드시 가지고 있어야 한다.description은

Media type은 request, response body data의 형식이다.웹 서비스 operations는 서로 다른 데이터 포맷을 받거나 응답할 수 있다. 요즘에는 보통 json, image다.request와 response 정의에 media type을 명시할

OpenAPI에서 paths는 /users 등의 endpoint를 의미한다.Operations는 paths에 대한 GET, POST, DELETE 등의 HTTP 메서드다.API paths와 operations는 API 명세서의 global paths section에 정

OpenAPI 3.0부터 paramters는 operation 혹은 path section의 parameters에 정의한다.paramter 정의를 위해 'name', 'in'(location), 'schema or content'(data type) descriptio

Serialization은 data structures 혹은 객체를 전송 가능한 형태(데이터스트림)로 만들고 후에 재구성하는 것을 말한다.OpenAPI 3.0은 배열과 객체를 operation parameters(path, query, header, cookie)로 사

request body는 보통 "create", "update"같은 operations(POST,PUT,PATCH)에 사용한다.OpenAPI 3.0에서 requestBody 키워드로 request body를 정의할 수 있다.body와 form 파라미터는 requestB

OpenAPI 3.0에서는 request content로 업로드 되는 파일과 multipart 요청으로 업로드 되는 파일을 정의할 수 있다.request payload가 file을 포함한다는 것을 설명하기 위해 requestBody 키워드를 사용한다.content 밑에

multipart request는 하나 이상의 데이터 셋을 하나의 body로 결합한다.보통 파일 업로드에 사용하거나 single request에 여러 media type이 사용되는 경우(JSON obejct와 파일이 함께 요청으로 전송되는 경우)에 사용한다.reques

API 명세서는 모든 API operations에 대한 responses를 명시해야 한다.각 operation마다 하나의 response는 반드시 정의되어야 한다. 일반적으로 성공 응답은 반드시 포함되어야 한다.response는 HTTP 상태 코드에 의해 정의며, 응답