이 글은 기계 번역의 미러 문서이며, 원본 기사로 바로 이동하려면 여기를 클릭해 주세요.

보기: 20232|회답: 0

[WebAPI] webAPI는 자동으로 도움말 문서를 생성합니다

[링크 복사]
게시됨 2016. 10. 6. 오후 3:08:16 | | | |
이전에 프로젝트 인터페이스 제공에 webapi를 사용했는데, 프로젝트 내에서 webapi 메서드와 주석에 따라 도움말 문서가 자동으로 생성되는 기능을 발견했고, 매우 강력한 Webapi 메서드도 테스트할 수 있습니다. 이제 여러분과 공유하겠습니다.
먼저 생성된 webapi 문서를 살펴보세요.
1. 다음 그림은 생성 도움말 문서의 상단 페이지를 보여주며, 여기서 Values가 컨트롤러이고, API 아래 목록에는 http 메서드(Get, POST 등), 요청의 동작, 메서드 설명이 나와 있습니다.
2. 아래 그림과 같이 빨간 상자의 링크를 클릭하여 API 메서드의 세부 정보 페이지를 엽니다.
3. 테스트 API를 클릭하여 다음 페이지를 열어

4. 매개변수를 입력하고 전송 버튼을 클릭한 후 다음 페이지를 열면 반환 값을 확인할 수 있습니다.

설정 단계는 다음과 같습니다:
개발 환경 VS2012 + MVC4 + WEB API
1. NuGet을 통한 웹 API 테스트 클라이언트 참조

DLL을 참조하면 다음과 같은 파일이 생성됩니다:
이것이 저희의 도움말 문서 인터페이스입니다


2. 프로젝트 속성에서 다음 설정을 하고, XMl 문서 파일을 확인하며, 경로를 설정하세요
3. 프로젝트의 App_Data 폴더 아래에 XmlDocument.xml 생성
4. AreasHelpPageApp_StartHelpPageConfig.cs 파일을 열고 다음 코드 주석을 취소합니다

프로젝트를 실행하고 http://localhost:3619/Help 를 열면 자동으로 생성된 API 문서를 볼 수 있는데, 이는 해당 문서의 이미지입니다

프로젝트 다운로드:

WebAPIHelper.part2.rar (893.15 KB, 다운로드 횟수: 1) WebAPIHelper.part1.rar (1.5 MB, 다운로드 횟수: 0)




이전의:SS-panel v3 실행 중 Python servers.py 오류가 발생
다음:오른쪽 클릭을 차단하고, F12 키를 피하고 소스 코드를 마세요
면책 조항:
Code Farmer Network에서 발행하는 모든 소프트웨어, 프로그래밍 자료 또는 기사는 학습 및 연구 목적으로만 사용됩니다; 위 내용은 상업적 또는 불법적인 목적으로 사용되지 않으며, 그렇지 않으면 모든 책임이 사용자에게 부담됩니다. 이 사이트의 정보는 인터넷에서 가져온 것이며, 저작권 분쟁은 이 사이트와는 관련이 없습니다. 위 내용은 다운로드 후 24시간 이내에 컴퓨터에서 완전히 삭제해야 합니다. 프로그램이 마음에 드신다면, 진짜 소프트웨어를 지원하고, 등록을 구매하며, 더 나은 진짜 서비스를 받아주세요. 침해가 있을 경우 이메일로 연락해 주시기 바랍니다.

Mail To:help@itsvse.com