api-doc

0열

1답변

내 프로젝트에 swagger-springmvc을 포함 시켰고 Swagger UI를 사용할 수있게되었지만 지금은 UI의 API에 대한 정보가 거의 없습니다. 내가 보는 모두는 반영을 통해 추출 된 정보입니다. /** * Read all users matching given filter * @param String filter The text by whic

7열

1답변

"Remotable"은 무엇을 의미합니까?

"원격 객체"에 대해 이야기 할 때 Android API 문서 란 무엇을 의미합니까? IBinder 상태에 대한 예를 들어, API 문서 : 이 인터페이스는 원격 가능 객체와의 상호 작용에 대한 추상적 인 프로토콜을 설명합니다. 하지만 검색했는데 ... "리모트 처리 가능한 객체가 그 대상이다 어쩌구 저쩌구 ..."와 같은 어떤 정의를 찾기 위해

10열

4답변

Python 모듈/패키지 이름 용 스핑크스 apidoc 섹션 제목

sphinx-apidoc을 실행 한 다음 make html을 실행하면 각 모듈/패키지의 끝에 "서브 패키지"및 "서브 모듈"섹션과 "모듈"섹션과 "패키지"섹션이있는 문서 페이지가 생성됩니다 목차 (TOC)의 이름. 스핑크스 소스를 편집하지 않고 이러한 추가 타이틀이 어떻게 쓰여지는 것을 막을 수 있습니까? 나는 그것이 스핑크스 소스의 apidoc.py 파일

1열

1답변

ApiDoc 오류 : parser plugin "apimethod"을 (를) 찾을 수 없습니다.

슬림 프레임 워크로 RESTful API를 작성했습니다. 내가 원하는 APIDoc 문서. 난 내가 또한 apidoc.json을 추가 /** * @ApiDescription(section="User", description="Get information about user") * @ApiMethod(type="get") * @ApiRoute(name="

3열

1답변

Swagger 용 api-doc 작성하기

Swagger UI를 사용하려고하는데 REST API에 대한 정확한 API를 설명하는 api-doc을 작성해야한다고 말합니다. 문제는 이것이 무엇을 의미하는지 전혀 모른다는 것입니다. 이 서류는 영어로 작성 되었습니까? 아니면 UI를 생성 할 수있는 특정 형식이 있습니까? 감사합니다.

3열

2답변

django-rest-swagger가 Markdown 문서 문자열을 HTML 코드로 구문 분석/변환하지 않습니다

지금까지 django-rest-swagger은 v0.1.10의 Markdown 구문에서 docstring을 지원합니다. 그러나 문서를 보려고하면 구문 분석 대신 HTML 코드로 변환하는 대신 일반 텍스트로 표시됩니다. 내가 사용하고 있습니다 : Django==1.5 Markdown==2.3.1 djangorestframework==2.3.10 djan

8열

1답변

nodejs/express로 작성된 기존 응용 프로그램의 api 문서를 작성해야합니다.

일반 old express로 작성된 개인 api가 있습니다. 그것을 밖으로 보내고 몇 가지 API를 설명서를 제공하는 시간. api 문서를 코드에 통합하기 위해 명시 적 앱을 다시 쓰고 싶지 않습니다. 주로 내 api를 문서화하기 위해 어떤 프레임 워크 나 스펙을 사용해야할지 모르겠다. 그렇기 때문에 실제로 특정 한 가지로 고정하고 싶지는 않다. 내 api

2열

1답변

@QueryParam을 사용한 FOSRES 번들 경로

Symfony 2.3.4 및 FOSRestBundle 0.13.1을 사용하고 있습니다. FOSRestBundle에서 자동 생성 할 경로를 구성했습니다. Eveything은 @QueryParam 주석을 어떤 메서드에 추가 할 때까지 훌륭하게 작동합니다. 이 주석은 경로를 변경하고 urara에서 추출 할 수있는 대신 매개 변수로 전달 될 것으로 기대합니다. 즉

0열

1답변

LiveScript API-Doc 생성?

JavaScript로 JSDuck을 사용했는데 LiveScript에 무엇을 사용해야합니까? JS 소스에 주석이 보존되지 않은 것 같습니다.

0열

2답변

apiDoc에 package.json을 둘 수있는 곳

apiDoc을 사용하여 WebAPI 인터페이스를 문서화하려고합니다. apiDoc 문서에는 package.json 파일을 사용하여 프로젝트 이름 및 최신 API 버전을 지정하는 방법이 설명되어 있습니다. 불행히도, 나는 이것을 작동시키지 못합니다. 이 파일은 어디에 배치해야합니까? 내가 생성 된 문서의 코드를 사용하여 폴더에, 문서화 된 코드를 사용하여 폴더