38
Express.js를 사용하는 restAPI를 작성 중입니다. 사용자가 API 정의를 볼 수있는 API 문서를 생성 할 수있는 방법이 있는지 궁금합니다. API 호출을 시도해 볼까요?Node.js 또는 Express.js REST API 문서 생성기
A
답변
24
Swagger는 API 문서를 자동 생성하는 놀라운 프로젝트입니다. Express 모듈이 포함되어 있습니다. 당신이 찾고있는 것은 좋은 자바 스크립트 문서 생성기입니다
54
. 나는 여기 괜찮은 것을 찾았다 http://apidocjs.com/example/. 이렇게하면 op와 같은 익스프레스를 사용할 수 있습니다.
Swagger는 API를 만들기위한 문서가 아닙니다. 그래서 당신은 그 기능을 얻으려면 전체 시스템을 배워야 할 것입니다.
Docco here JSDoc here 및 an article on Documentor for Node
관련 문제
- 1. REST API 소셜 로그인 [express.js]
- 2. node.js - REST API 보안. SSL 또는 OAuth2?
- 3. Node.js API REST 보안
- 4. REST API 문서 생성
- 5. backbone.js + node.js - express.js
- 6. React.js with Node.js Rest API
- 7. Node.js/Express.js/Angular2의 ForBiddenError
- 8. node.js + express.js + dust.js issues
- 9. node.js express.js slash css
- 10. Express.js res.send - Node.js 설명서에 있습니까?
- 11. json 문자열의 PHP REST API 클래스 생성기
- 12. REST API 반환 문서 내용
- 13. Sinatra 빌드 REST API 문서
- 14. REST API 또는 websocket?
- 15. 가짜 문서/코드 생성기 또는 다시 작성자
- 16. 세션 및 socket.io (node.js, express.js)
- 17. Node.JS/Express.JS CouchDB 세션 저장소
- 18. django-rest-framework 및 swagger API 문서
- 19. Test를위한 테스트 데이터베이스 생성 및 연결 Express.JS REST API
- 20. 좋아하는 문서 생성기 시스템?
- 21. Testcomplete 용 문서 생성기
- 22. 옵션의 django-rest-framework 문서 API
- 23. Symfony에서 자동으로 REST API 문서 생성
- 24. Swagger를 사용하는 Spring REST API 문서
- 25. 개미를 사용하여 REST API 문서 생성을 알리기
- 26. 라우트에 대한 REST API 문서 자동화
- 27. REST 백엔드 대 REST API (또는 API 백엔드)
- 28. 클라우드 메시징 또는 REST API?
- 29. REST API - PUT 또는 POST할까요?
- 30. Node.js 용 Google 문서 도구
감사를 @dankohn :
는 내가 아직 완전히 들여다 유망 보인다있는하지 않은 것으로 여기 몇 개를 발견했다. 나는 그것을 조사하고있다. –Express에서 구성된 라우트를 기반으로 자동 생성합니까? – lostintranslation
@lostintranslation AFAIK 그들은 그렇지 않습니다. 스와거 문서는 yml 파일에 저장됩니다. – BillyTom