«swagger» 태그된 질문

Swashbuckle을 사용하여 API 문서가 자동으로 생성되는 C # ASP.NET WebAPI 응용 프로그램이 있습니다. 설명서에서 특정 방법 을 생략 하고 싶지만 Swagger가 Swagger UI 출력에 포함시키지 않도록 Swagger에 지시하는 방법을 알아낼 수 없습니다. 나는 그것이 모델이나 스키마 필터 를 추가하는 것과 관련이 있다고 생각하지만 무엇을 해야할지 명확하지 않으며 문서는 메소드의 출력을 …

135 c#  asp.net  .net  swagger 

최근에 SpringMvc 와 swagger-ui (v2)로 편안한 API를 작성했습니다 . Postman에서 가져 오기 기능을 발견했습니다. 그래서 내 질문은 Postman이 필요한 파일을 만드는 방법입니다. 나는 Swagger에 익숙하지 않습니다.

120 swagger  postman 

인증 / 보안 체계에 다음과 같이 헤더를 설정해야 함을 전달하려고합니다. Authorization: Bearer <token> 이것이 내가 swagger 문서를 기반으로 한 것입니다 . securityDefinitions: APIKey: type: apiKey name: Authorization in: header security: - APIKey: []

112 swagger  swagger-2.0  swagger-editor 

내 프로젝트에는 Spring Security가 있습니다. 주요 문제 : http : // localhost : 8080 / api / v2 / api-docs 에서 swagger URL에 액세스 할 수 없습니다 . 인증 헤더가 없거나 잘못되었습니다. 브라우저 창의 스크린 샷 My pom.xml에는 다음 항목이 있습니다. <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version> …

92 spring-mvc  swagger  swagger-ui  swagger-2.0  springfox 

PHP로 작성된 일부 REST API의 경우 Swagger 문서 를 작성하라는 요청을 받았으며 기존 API에 주석을 추가하고 문서 를 작성 하는 쉬운 방법을 몰랐기 때문에 지금은 이 편집기 를 사용하여 일부를 생성했습니다. 해당 편집기를 사용하여 만든 JSON 및 YAML 파일을 저장했으며 이제 최종 대화 형 Swagger 문서를 만들어야합니다 (이 문장은 순진하고 …

88 yaml  swagger  swagger-php 

간단한 Spring으로 작성된 ReSTFul API가 있습니다 (Spring Boot 없음, 멋진 물건 없음!). 여기에 Swagger를 구현해야합니다. 지금까지 인터넷의 모든 페이지는 이식성이 전혀없는 혼란스러운 구성과 부풀어 오른 코드로 나를 미치게 만들었습니다. 이 작업을 수행하는 데 도움이되는 샘플 프로젝트 (또는 일련의 세부 단계)가 있습니까? 특히 swagger-springmvc를 사용하는 좋은 샘플을 찾고 있습니다. 나는 그것이 …

85 spring  spring-mvc  swagger 

같은 매개 변수가 있다고 가정 해 봅시다 limit. 이것은 모든 곳에서 사용되며 업데이트해야 할 경우 모든 곳에서 변경해야하는 고통입니다. parameters: - name: limit in: query description: Limits the number of returned results required: false type: number format: int32 $ ref를 사용하여 다른 곳에서 정의하고 재사용 할 수 있습니까? 나는 우연히 …

84 swagger  swagger-2.0  openapi 

내 "단순화 된"API에서 모든 응답은 기본 "응답"클래스에서 파생 ( 상속 )됩니다. 응답 클래스되어 이루어지는 메타 가득 헤더, 상기 사용자가 요청하는 코어 데이터를 포함하는 본체. 응답 (JSON)은 모든 메타 데이터가 첫 번째 "레이어"에 있고 본문이 "본문"이라는 단일 속성이되도록 배치됩니다. response |--metadata attribute 1 (string/int/object) |--metadata attribute 2 (string/int/object) |--body (object) |--body …

81 swagger 

지난 2 년 동안 Springfox에서 Spring Boot Applications를 작업했습니다. Springfox는 REST API에 대한 문서 및 테스트 UI를 생성합니다. 대단 했어. 그러나 실제로 Springfox 프로젝트는 죽었고 최신 Spring을 지원하지 않습니다. 세 가지 질문이 있습니다 Swagger UI를 직접 생성하는 다른 방법이 있습니까? 다른 도서관 / 프로젝트? swagger ui를 어떻게 Spring Boot 프로젝트에 …

11 spring-boot  swagger  swagger-ui  springfox 

.Net core 3.0으로 Web Api를 개발 중이며 SwashBuckle.Swagger와 통합하려고합니다. 잘 작동하지만 JWT 인증을 추가하면 예상대로 작동하지 않습니다. 이를 위해 아래 코드를 추가했습니다. services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo { Title = "My Web API", Version = "v1" }); c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme { Description = "JWT Authorization header using the Bearer …

10 swagger  asp.net-core-webapi  swashbuckle  .net-core-3.0