programing tip

Node.js 또는 Express.js REST API 문서 생성기

itbloger 2021. 1. 7. 07:41
반응형

Node.js 또는 Express.js REST API 문서 생성기


Express.js를 사용하여 restAPI를 작업 중이며 사용자가 API 정의를 보거나 API 호출을 시도 할 수있는 API 문서를 생성 할 수있는 방법이 있는지 궁금합니다.


Swagger는 API 문서 자동 생성을위한 놀라운 프로젝트입니다. Express 모듈이 포함되어 있습니다.

http://swagger.io/

https://github.com/wordnik/swagger-node-express


당신이 찾고있는 것은 좋은 JavaScript 문서 생성기입니다. http://apidocjs.com/example/ 에서 괜찮은 것을 찾았습니다 . 이렇게하면 OP가 요청한대로 Express 만 사용할 수 있습니다.

Swagger는 문서 생성을 위한 것이 아니라 API 만들기 위한 것 입니다. 따라서 해당 기능을 사용하려면 전체 시스템을 배워야합니다.

여기에서 아직 완전히 살펴 보지 않은 몇 가지를 더 찾았는데, 이는 유망 해 보입니다.
Docco here JSDoc 여기Documentor for Node에 대한 기사


이 라이브러리는 문서와 경로 선언 논리를 가깝게 유지하는 데 매우 유용하다는 것을 알았습니다.

https://www.npmjs.com/package/swagger-jsdoc

참조 URL : https://stackoverflow.com/questions/18626191/node-js-or-express-js-rest-api-document-generator

반응형