[ 살펴보기 ] - Swagger

Series

[ 살펴보기 ] - Swagger

Rest API documentation을 위해 다양한 tool을 제공하는 Swagger를 살펴보자.

[ 살펴보기 ] Swagger - OpenAPI Basics
OpenAPI specification은 REST API description을 위해 사용되는 format이다. OpenAPI specification을 통해 api의 endpoint나 request parameters, return structure등을 표현할 수 있으며 YAML 또는 JSON 형태로 작성될 수 있다. 그리고 Swagger UI는 작성된 OpenAPI specification을 통해 API 정보를 확인할 수 있는 UI를 제공한...
Nov 11, 20245 min read11
[ 살펴보기 ] Swagger - OpenAPI Request Body, Response
지난 포스트에선 OpenAPI specification의 기본적인 구조를 살펴보았다. 해당 포스트에선 API endpoint의 request body와 response type 관련 specification에 대해 살펴보자. Reqeust body Post method를 통해 새로운 데이터를 생성하거나 Put, Patch method를 통해 기존 데이터를 수정할 때 Client는 request body에 생성 또는 수정을 원하는 데이터를 함께 ...
Nov 12, 20245 min read9
[ 살펴보기 ] Swagger - OpenAPI Data Types
OpenAPI specification에서 사용할 수 있는 basic types은 다음과 같다 : string, number, ingeter, boolean, array, object. schema의 data type은 type keywowrd를 통해 설정한다. paths: /users: post: summary: Add a new user requestBody: description: a new ...
Nov 19, 20247 min read8