ASP.NET MVC 의 WEB API 에 대한 도움말 페이지 HELP PAGE 생성

 

ASP.NET MVC 의 WEB API 에 대한 도움말 페이지 HELP PAGE 를 만들어 보도록 하겠습니다.

ASP.NET MVC 프로젝트를 하나 만들어 봅니다. 저는 Intra.Web 이라는 프로젝트를 만들었습니다.

이제 ASP.NET MVC 의 WEB API 의 HELP PAGE 도움말 페이지를 만들어 보죠.

먼저 패키지 관리자 콘솔을 엽니다. PACKAGE ADMINISTRATOR CONSOLE 이라고도 하죠.

 

이제 방금 생성했던 프로젝트명을 "기본 프로젝트" 에 맞춰서 설정을 하고, 아래와 같이 Install-Package Microsoft.AspNet.WebApi.HelpPage 를 입력하면 .NET FRAEMWORK 버전에 맞게 설치를 직접 해 줍니다. 저는 .NET FRAMEWORK 4.5.2 로 ASP.NET MVC 를 실행하여 아래와 같이 설치 된 상태입니다. (https://www.nuget.org/packages/Microsoft.AspNet.WebApi.HelpPage/ )

 

WEB API 를 만들기 위해서는 CONTROLLER 에서 만들 수 있습니다. UserApi 컨트롤러를 생성한 다음, ApiController 를 상속 받으면 됩니다. 간단하게 만들어서 반환은 bool 형태로 하였습니다.

namespace Intra.Web.Controllers
{
    public class UserApiController : System.Web.Http.ApiController
    {

        // GET: UserApi

        public bool Index()
        {
            return false;
        }
    }
}  

 

빌드 한 이후에 web api 의 도움말 페이지가 어떻게 보이는지 확인해 보겠습니다.이는 Areas 라는 폴더에 HelpPage 라고 자동 생성되어 있습니다. 그 안에 코드가 들어가 있습니다.

이를 실행하기 위해서는 http://localhost/Help 경로로 실행해 주면 웹화면에 보입니다. 이전에 만들었던 UserApiController 의 Web Api 설명서가 아래와 같이 보이네요.

더 상세한 내용은 아래 사이트를 참고 하시기 바랍니다.

http://www.taeyo.net/Columns/View.aspx?SEQ=469&PSEQ=35