ASP.NET Web API 는 설명 을 자동 으로 도움말 문 서 를 만 드 는 방법

ASP.NET Web API 주석 에서 도움말 문서 생 성
기본적으로 ASP.NET Web API 는 Controller 의 설명 에서 도움말 문 서 를 만 들 지 않 습 니 다.설명 을 웹 API 도움말 문서 의 일부분 으로 하려 면 도움말 문서 의 설명 항목 에 방법 설명 에 있 는 summary 를 표시 하려 면 설정 작업 이 필요 합 니 다.
먼저 Visual Studio 에서 웹 API 프로젝트 의 속성 페이지 를 엽 니 다.Build 설정 페이지 에서 XML document file 을 선택 하고 생 성 할 XML 파일 의 경 로 를 입력 하 십시오.예 를 들 어 AppData\OpenAPI.XML。

그리고 프로젝트 를 컴 파일 하면 해당 하 는 경로 에서 xml 파일 을 생 성 합 니 다.
이어서 Areas\HelpPage\앱 열기Start\\HelpPageConfig.cs 파일,config.SetDocumentationProvider 코드 설명 취소,경로 변경:
그리고 다시 컴 파일 해서/help 페이지 를 방문 하면 효 과 를 볼 수 있 습 니 다.

config.SetDocumentationProvider(new XmlDocumentationProvider(HttpContext.Current.Server.MapPath("~/App_Data/OpenAPI.xml")))
이상 의 간단 한 소 개 를 통 해 여러분 에 게 도움 이 되 기 를 바 랍 니 다.

좋은 웹페이지 즐겨찾기