8
일반 old express로 작성된 개인 api가 있습니다. 그것을 밖으로 보내고 몇 가지 API를 설명서를 제공하는 시간.nodejs/express로 작성된 기존 응용 프로그램의 api 문서를 작성해야합니다.
api 문서를 코드에 통합하기 위해 명시 적 앱을 다시 쓰고 싶지 않습니다. 주로 내 api를 문서화하기 위해 어떤 프레임 워크 나 스펙을 사용해야할지 모르겠다. 그렇기 때문에 실제로 특정 한 가지로 고정하고 싶지는 않다.
내 api (즉, 다른 서버 또는 하위 도메인을 실행하고 싶지 않음)의 하위 리소스로 문서를 제공하고 싶습니다. 어쩌면 '/ api/docs'. 플러스는 또한 내 응용 프로그램 내에서 워드 프로세서를 구문 분석 할 수있는 UI가 될 것이고 적어도 html로 문서의 멋진 프리젠 테이션을 제공 할 수 있습니다 (API 상호 작용은 플러스 임).
같은 내용은 멋지지만, 내 표현 코드를 모두 다시 작성해야 쓸데없는 것들을 통합 할 수 있습니다. 그 시점에서 나는 큰 투자를했고 기품이 강하게 결합되었습니다.
기존 경로를 최소한으로 침범하는 방식으로 내 API를 문서화하기 위해 swagger 나 i 아니면 다른 것을 제공 할 수있는 방법이 있습니까?
편집 :
내가 손으로 쓴 문서에서 자신감 사양을 제공 할 수있다. 내가보기에 문제는 당신이 swagger doc에서 basePath를 정의해야한다는 것이다. 그렇다고해서 다른 도메인에 쉽게 배포 할 수있는 것은 아닙니다.
언제든지 메모장을 열어 수동으로 문서를 .html 파일로 작성할 수 있습니다. 다음은 [Mashery] (http://www.mashery.com/product/io- docs) : http://www.infoq.com/research/api-documentation – FoggyDay
당신도 당신의 사양을 구문 분석하고 그것을 아름답게 보여줄 것입니다 swiger UI를 알고 있어야합니다 + API를 통합 당신이 사양을 쓸데없는 사양에 따라 작성 제공 . – Sikorski
감사합니다. 나는 swagger-ui가 있다는 것을 알았습니다. 기존 노드 프로젝트에 의존성으로 추가 할 수 있는지 알고 있습니까? – lostintranslation