티스토리 뷰
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 리스트가 자동으로 표시되지만, 빨간색 박스 부분은 표시가 되지 않을 거에요 (사용법은 하단 참조)
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 접속
'WEB TIP > C# ,ASP.NET' 카테고리의 다른 글
Visual Studio에서 Semanti-UI 테마 적용 (0) | 2016.09.30 |
---|---|
Visual Studio Team Services 연결 방법 (0) | 2016.09.07 |
Visual Studio 2015에서 Angular HTML Attribute 추가 (0) | 2016.04.11 |
HTTP Header 정보 삭제 (0) | 2016.02.17 |
VS2016 설치 시 DNX 오류 해결 방법 (0) | 2015.11.24 |
댓글
공지사항
최근에 올라온 글
최근에 달린 댓글
- Total
- Today
- Yesterday
링크
TAG
- ADO
- UTF-8
- 오라클
- IIS
- 인덱스
- 폰트색상
- SQL
- 숙취
- gitignore
- ASP.NET
- 문자열 분리
- HttpCookie
- injection
- Visual Stuiod Team Services
- pang caching
- 영어
- Git
- case
- jquery
- MS-SQL
- oracle
- Windows2003
- 암호화
- asp
- c#
- index
- offline application cache
- Convert
- SEQUENCE
- .NET Core
일 | 월 | 화 | 수 | 목 | 금 | 토 |
---|---|---|---|---|---|---|
1 | 2 | 3 | 4 | 5 | 6 | |
7 | 8 | 9 | 10 | 11 | 12 | 13 |
14 | 15 | 16 | 17 | 18 | 19 | 20 |
21 | 22 | 23 | 24 | 25 | 26 | 27 |
28 | 29 | 30 |
글 보관함