첫째, 자신감이 왜 허세를 무엇을 사용합니까?

　　자신감은 점점 별도의 전면 및 후면 끝을 사용하여 더 많은 프로젝트, API는 프런트 엔드와 백엔드 통신 링크, API 문서가 점점 중요 해지고있다가되었다 지금은 규범 적 프레임 워크와 완전하고있다. 그것은이 컬렉션하게 자동으로 온라인 + + 테스트 아름다운 문서를 생성하기 위해 점점 더 인기를 한 프레임 자신감에 있습니다.

　　우리가 워드, 엑셀 핸드 코딩 된 인터페이스 문서를 통과하기 전에, 우리는 다음과 같은 경우가 발생하지 않은 :

백엔드 인터페이스 프런트 엔드는 종종 문서가 실제 상황과 일치하지 불평;
종종 너무 늦게, 많은 에너지 비용 또는 업데이트에 잊고 준비 및 유지 보수 인터페이스 문서의 후단;

　　자신감의 완벽한 (밀접하게 매일 개발 습관의 개발, 코드 주석을 업데이트와 관련) 새로운 API 버전이나 반복적 인 버전 개발 만 자신감 설명 파일을 업데이트해야하는 경우 상기와 같은 문제점을 해결하기 위하여, 자신감, 당신은 자동으로 인터페이스를 생성 할 수 있습니다 문서 및 클라이언트 서버 코드, 일관성 코드, 서버 코드 및 인터페이스 문서 측 호출 그래서;

둘째, 참고 문헌 및 구성 자신감

도구 -> NutGet 패키지 관리자 - 다음> 패키지 관리자 콘솔은 자신감 플러그 쉘 명령을 추가합니다 : 설치 패키지 Swashbuckle.AspNetCore -version 4.0.1 -Study.NetCore
다음과 같이 프로젝트 열기 NetCore Startup.cs 항목 클래스 (프로그램 항목), 자신감을 배열 :

            # 지역 자신감配置
            services.AddSwaggerGen (SWG => 
            { 
                swg.SwaggerDoc ( " V1 ", 새로운 Swashbuckle.AspNetCore.Swagger.Info {버전 = " V1 " 제목 = " Study.NetCore의 API " , 설명 = " API-说明文档" , TermsOfService = " 없음 " , 연락 = {새로운 Swashbuckle.AspNetCore.Swagger.Contact 이름 = " Study.NetCore "이메일 = " ", URL을 = " " });})}; #endregion

시작 자신감 미들웨어 구성 클래스는 다음과 같습니다 :

            # 지역启动자신감 
            app.UseSwagger (); 
            app.UseSwaggerUI (SWG => 
            { 
                swg.SwaggerEndpoint ( " /swagger/v1/swagger.json ", " APIExplainDoc ' );}); #endregion

프로젝트를 시작, 우리는 페이지가 다음 페이지로 바로 이동 볼 수 있습니다 :

우리 입 / 자신감이 정상적으로 SwaggerUI 페이지를 입력 할 수 있습니다, 우리는 SwaggerUI 페이지로 경로를 기본. 다음과 같이 열기 launchSettings.json 개정 :

우리는 자신감 프로젝트를 실행 이러한 방법으로, 기본 SwaggerUI 페이지으로 설정되어 있습니다;

당신이 형식적인 환경을 게시 할 경우 기본 홈 페이지의 상단에 유효하지 않은 시작, 또는 우리가 수동으로 입력 도메인 이름 다시 / 자신감, 우리는 구성 swg.RoutePrefix 구성을 = "필요 때마다"와 같은 다음 발견 할 것이다 :

            # 지역启动자신감 
            app.UseSwagger (); 
            app.UseSwaggerUI (SWG => 
            { 
                swg.SwaggerEndpoint ( " /swagger/v1/swagger.json ", " APIExplainDoc " ) swg.RoutePrefix = "" ;}); #endregion

코멘트 SwaggerUI 인터페이스를 추가 3.에서 주문

마우스 오른쪽 단추로 프로젝트 이름 -> 속성 -> 빌드 -> 다음과 같이 수정 ConfigureServices에 의해 프로젝트가 시작되면 할 때 XML 파일을 읽어, 다음과 같은 XML 문서 파일을 확인, XML 문서 파일을 확인 :

            # 지역 자신감配置
            services.AddSwaggerGen (SWG => 
            { 
                swg.SwaggerDoc ( " V1 ", 새로운 Swashbuckle.AspNetCore.Swagger.Info {버전 = " V1 " 제목 = " Study.NetCore의 API " , 설명 = " API-说明文档" , TermsOfService = " 없음 " , 연락 = 새로운 Swashbuckle.AspNetCore.Swagger.Contact {이름 = " Study.NetCore "이메일 = " ", URL = " " }}); var에 bashPath =PlatformServices.Default.Application.ApplicationBasePath, VAR = Path.Combine XMLPath (bashPath는 " Study.NetCore.xml " ); (XMLPath, swg.IncludeXmlComments true로는); // 이 코멘트 컨트롤러이다 }); #endregion

이 프로젝트를 실행 한 후, 의견은 매우 완벽한 있습니다. 으로는 다음과 같습니다 :

[개인 학습] 자신감 구성 및 사용

첫째, 자신감이 왜 허세를 무엇을 사용합니까?

둘째, 참고 문헌 및 구성 자신감

코멘트 SwaggerUI 인터페이스를 추가 3.에서 주문

추천