api-doc

0열

1답변

Nodejs/apidocjs : 템플릿없이 특정 URL에 생성 된 문서를 렌더링하는 방법

다른 누군가가 작성한 nodejs 프로젝트에 대해 apidocs을 쓰고 있습니다. 누군가가 "myurl.com/docs/api"를 방문하면 설명서 페이지가 표시되기를 바랍니다. 내 문서 디렉토리가 "app/public/app/docs/apidoc /"아래에 있습니다. 경로를 사용하여 표시하려고하지만 오류가 표시됩니다. '오류 :보기를 조회하지 못했습니다.'

4열

1답변

Django REST Swagger는 어디에서 스키마 파일을 생성합니까?

Django REST Swagger에서 생성 한 Swagger 문서를 수정하고 싶습니다. Django REST Swagger가 생성하는 API 정의 또는 스키마 파일을 찾고 싶습니다. 나는 그 파일들을 찾을 수 없었습니다. Django REST Swagger가 API 문서를 생성 할 때 생성되는 YAML 또는 JSON 파일과 같은 것이 있습니까? 서버에서

0열

1답변

apiDocJs의 한 클래스 파일에 두 개의 @apiName 함수가있는 방법은 무엇입니까?

여러 개의 경로를 처리 할 수있는 서블릿이 있는데 그 중 하나를 기반으로 다른 작업을 수행합니다. http://apidocjs.com을 사용하여 클래스 파일의 여러 함수를 문서화하려고하지만 두 개를 표시하는 방법을 알아낼 수 없습니다. 나는이 때 첫 번째 하나가 표시됩니다 (아래 참조) : 두 개의 주석 블록으로 분할하는 경우가 /** * @api {ge

2열

1답변

램 리소스에 대한 일반적인 응답을 포함하는 방법

나는 raml 문서를 가지고 있으며 해당 API에 새 API 문서를 추가하려고합니다. 기본 RAML 문서를 살펴 보았습니다. 나는 raml 파일을 가지고 있습니다. #Filename: base.raml title: Test RAML documentation: - title: Test RAML docs first time :) conte

0열

1답변

API Doc apiGroup 및 apiName이 제대로 작동하지 않습니다.

이것은 apiDocs를 처음 사용하는 것으로 제공된 문서를 정확히 따르고 있습니다. 문제는 apiName과 apiGroup을 정의하지만 출력에는 apiGroup 만 표시된다는 것입니다. users //apiGroup, it's ok users //Should be @apiName, but showing the group Delete user devi

1열

1답변

apidocs가 sphinx-apidoc에서 모듈 대신 패키지를 사용하는 방법

나는 docstrings을 사용하여 파이썬 코드를 문서화하고 sphinx-autodoc을 사용하여 apidoc HTML을 생성합니다. 내 패키지의 구조는 다음과 같습니다 : mainpackage.subpackage.module, 나는 모듈의 클래스에 mainpackage.subpackage.Class이 아니라 mainpackage.subpackage.mod

4열

1답변

봄 레스트 문서가 HTML을 생성하지 않음

봄 휴식 문서 용 getting started guide을 한 단어 씩 따라 갔지만 생성 된 스 니펫에서 HTML을 가져올 수 없습니다. 스 니펫은 내가 구성한 디렉토리 (빌드/generated-snippets)에서 제대로 생성되지만 스 니펫에서 생성 된 html5/디렉토리는 볼 수 없습니다. 기타 문서 at some point 빌드가 실행될 때 항아리에

3열

4답변

Symfony - 주석을 가져 오지 않았습니다

저는 Symfony 프레임 워크를 사용하고 있으며 내 프로젝트의 RESTful API에 자동 문서 엔진을 추가하려고합니다. 일부 검색 후 apidoc 엔진 (http://apidocjs.com/)을 발견했습니다. 그것은 아주 간단하게 작동합니다. 여러분은 RESTful API와 문서가 생성 될 모든 컨트롤러에 대한 주석을 추가해야합니다. 주석의 예는 다음과

1열

1답변

모카 BDD 테스트에서 API html 문서를 생성하는 방법은 무엇입니까?

필자는 자동화 된 API 문서 세대 인 Spring Boot 자바 프레임 워크로 프로젝트 작업을했습니다. BDD/통합 스타일 테스트를 실행할 때마다 mocha 테스트에서 작성된 api 파란색 프린트 파일이 있습니다. 그런 다음 generate-html-from-api 청사진을 실행했습니다. 나는이 접근법이 두 가지 장점을 가지고 있기 때문에 좋아했다. 1)

0열

2답변

낙천 api 사용 방법 주문 정보를 얻으려면?

나는 rakuten API를 사용하여 프로젝트를 진행하고 있습니다. https://webservice.rakuten.co.jp/document/에서 rakuten api 문서를 읽었지만 주문 번호를 입력으로 받아서 출력 (구매자, 제품, 가격 ...)으로 주문 정보를받는 API를 찾지 못했습니다. 비슷한 API가 있습니까? 감사합니다.