swagger
-
개요open api 프로젝트를 진행하던 중 api 문서를 만들 차례가 다가왔고, swagger의 끔찍한 ui를 피하기 위해 어떤 라이브러리를 사용할까 고민하다 apiDoc이라는 간단한 api 문서 생성 라이브러리를 찾아 사용하게 되었다.apiDoc 공식 Live Demo프로젝트 구조project/├── doc/│ ├── assets/│ └── index.html├── src/│ ├── controllers/│ │ └── userController.js│ └── routes/│ └── userRoutes.js├── app.js├── .gitignore├── apidoc.json└── package.jsonapiDoc 사용법1. 라이브러리 설치npm install --save..
express - apiDoc 라이브러리로 api 문서 만들기개요open api 프로젝트를 진행하던 중 api 문서를 만들 차례가 다가왔고, swagger의 끔찍한 ui를 피하기 위해 어떤 라이브러리를 사용할까 고민하다 apiDoc이라는 간단한 api 문서 생성 라이브러리를 찾아 사용하게 되었다.apiDoc 공식 Live Demo프로젝트 구조project/├── doc/│ ├── assets/│ └── index.html├── src/│ ├── controllers/│ │ └── userController.js│ └── routes/│ └── userRoutes.js├── app.js├── .gitignore├── apidoc.json└── package.jsonapiDoc 사용법1. 라이브러리 설치npm install --save..
2025.01.15 -
REST APIREST 위키피디아정의HTTP URI 를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE) 를 통해 해당 자원에 대한 CRUD Operation(Create, Read, Update, Delete)을 적용하는 것GET - Read : 데이터 요청POST - Create : 데이터 생성PUT - Update : 데이터 전체 업데이트PATCH - Update : 데이터 일부 업데이트DELETE - Delete : 데이터 삭제장점널리 사용되고 있기에 익숙하다.REST API의 메시지를 읽는 것 만으로 요청의 의도를 파악할 수 있다.서버와 클라이언트가 분리되어있어 시스템 확장이 편하다.단점공식적인 표준이 존재하지 않다.엄격한 표준이..
API - REST API와 SwaggerREST APIREST 위키피디아정의HTTP URI 를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE) 를 통해 해당 자원에 대한 CRUD Operation(Create, Read, Update, Delete)을 적용하는 것GET - Read : 데이터 요청POST - Create : 데이터 생성PUT - Update : 데이터 전체 업데이트PATCH - Update : 데이터 일부 업데이트DELETE - Delete : 데이터 삭제장점널리 사용되고 있기에 익숙하다.REST API의 메시지를 읽는 것 만으로 요청의 의도를 파악할 수 있다.서버와 클라이언트가 분리되어있어 시스템 확장이 편하다.단점공식적인 표준이 존재하지 않다.엄격한 표준이..
2024.06.25