C# Swagger 사용 예제

C# Swagger 사용 예제

공식 홈페이지: http://swagger.io/

Visual Studio에서 WEB API 프로젝트를 생성하셨다면, Nuget에서 swashbuckle를 설치하시면 됩니다. 

* ASP.NET Core
- ASP.NET Web API Help Pages using Swagger
- http://www.talkingdotnet.com/add-swagger-to-asp-net-core-web-api/

swashbuckle를 설치하시면 아무런 설정 없이 http://사용자 도메인/swagger/ui 으로 접속하시면 생성하신 API 리스트가 자동으로 표시되지만, 빨간색 박스 부분은 표시가 되지 않을 거에요 (사용법은 하단 참조)

Swagger 예제 사이트

C# XML Comments를 이용하여 API Descript과 Implementation Notes 표시하기

참조 사이트: Github Issue, Github Readme, MS Documentation

1. FormatXmlCommentProperties.cs 생성

2. /App_Start/SwaggerConfig.cs 수정

3. Visual Studio 프로젝트 속성 > 빌드 > 하단의 XML 문서 파일 체크 후 bin폴더의 프로젝트명.xml 경로 설정

4. XML Comments 생성 (해당 Controller의 액션 메서드에서 /// 입력)

5. 프로젝트 빌드 후 http://사용자 도메인/swagger 접속