ASP.NetCore Swagger 실전 사용

구 덩이 를 밟 아 도 솥 을 지지 않 습 니 다..NET Core 는 Swagger 가 가 져 온 도움 에 대해 Swagger 를 사용 합 니 다.
Swagger 에 대하 여
swagger 가 뭐야?
사람과 컴퓨터 로 하여 금 소스 코드 를 볼 수 없 거나 문 서 를 볼 수 없 거나 인터넷 트 래 픽 을 통 해 검 측 할 수 없 는 상황 에서 각종 서비스의 기능 을 발견 하고 이해 하 게 한다.

Swagger™ REST API 에 언어 와 무관 한 표준 인 터 페 이 스 를 정의 하 는 것 이 목표 입 니 다.그 규범 에 따라 인터페이스 와 인터페이스 와 관련 된 정 보 를 정의 해 야 한다.Swagger 를 통 해 파생 된 일련의 프로젝트 와 도 구 를 통 해 각종 형식의 인터페이스 문 서 를 생 성하 고 다양한 언어의 클 라 이언 트 와 서버 의 코드 를 생 성 하 며 온라인 인터페이스 디 버 깅 페이지 등 을 만 들 수 있다.
가 져 온 도움
프로젝트 가 시작 단계 에 있 을 때
안정 적 인 백 엔 드 프레임 워 크 가 있 으 면 업무 수요 에 따라 서버 호출 층 의 코드(즉,contrller 와 그 참조 대상)를 직접 작성 한 다음 에 Swagger 를 통 해 관련 설명 파일 을 생 성하 면 사용 자 는 직접 사용 할 수 있 습 니 다.
배경 프레임 워 크 가 성숙 하지 않 거나 디자인 에 있 지만 업무 수요 에 따라 기다 리 는 것 이 아니 라 더 많은 작업 을 할 수 있 습 니 다.먼저 데이터 수요 에 따라 Swagger 설명 파일 을 작성 하고 이 설명 파일 을 통 해 인터페이스 문 서 를 생 성하 여 프로젝트 의 관련 개발 을 안내 합 니 다.
프로젝트 가 교체 단계 에 있 을 때
프로젝트 의 지속 적 인 개발 에 있어 백 엔 드 직원 들 은 Swagger 설명 파일 과 인터페이스 문 서 를 주목 하지 않 아 도 됩 니 다.변경 이 필요 하면 인터페이스 변 화 를 초래 하고 직접 프로 그래 밍 하여 실현 할 수 있 습 니 다.그리고 새로운 설명 파일 과 인터페이스 문 서 를 생 성 한 후에 프론트 에 주면 됩 니 다.
Swagger 사용 하기
우선,새로운 WebAPI 프로젝트 를 만 들 고 Nuget 에서 해당 하 는 패 키 지 를 찾 습 니 다.Swashbuckle 을 검색 하면 많은 애플 리 케 이 션 패키지 가 나타 납 니 다.설명 에 따라 필요 한 인용 을 선택 할 수 있 습 니 다.저 는 여기 서 Swashbuckle.AspNetCore.Filters 를 사용 하고 있 습 니 다.

다음은 Startup 에 다음 코드 를 삽입 합 니 다.
등록 서비스

services.AddSwaggerGen(options =>
      {
        options.SwaggerDoc("v1", new OpenApiInfo
        {
          Title = "HTTP API   ",
          Version = "v1",
          Description = "     HTTP API。"
        });
      });

중간 부품

 //         Swagger  JSON   
      app.UseSwagger();
      //        swagger-ui，  Swagger JSON   
      app.UseSwagger().UseSwaggerUI(c =>
      {
        c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
      });

그리고 사용 할 수 있 습 니 다.대응 주 소 를 요청 합 니 다.https://localhost:44375/swagger/index.html예제 코드 에 있 는 Weather Forecast.cs 를 볼 수 있 습 니 다.

ASP.NetCore 의 Swagger 사용 실전 에 관 한 이 글 은 여기까지 소개 되 었 습 니 다.더 많은 관련 ASP.NetCore 의 Swagger 사용 내용 은 저희 의 이전 글 을 검색 하거나 아래 의 관련 글 을 계속 찾 아 보 세 요.앞으로 도 많은 응원 부 탁 드 리 겠 습 니 다!