คำถามติดแท็ก swagger

ฉันมีโปรแกรม C # ASP.NET WebAPI กับเอกสาร API ถูกสร้างขึ้นโดยอัตโนมัติโดยใช้Swashbuckle ฉันต้องการที่จะละเว้นวิธีการบางอย่างจากเอกสาร แต่ฉันไม่สามารถหาวิธีที่จะบอก Swagger ไม่ให้รวมไว้ในการส่งออก Swagger UI ฉันรู้สึกว่ามันเป็นสิ่งที่ต้องทำเกี่ยวกับการเพิ่มแบบจำลองหรือตัวกรอง schemaแต่ไม่ชัดเจนว่าจะทำอย่างไรและเอกสารประกอบดูเหมือนจะให้ตัวอย่างของวิธีการปรับเปลี่ยนผลลัพธ์สำหรับวิธีการเท่านั้นไม่เอาออกอย่างสมบูรณ์จากผลลัพธ์ ขอบคุณล่วงหน้า.

135 c#  asp.net  .net  swagger 

เมื่อเร็ว ๆ นี้ฉันได้เขียน APIs ที่สงบด้วยSpringMvcและ swagger-ui (v2) ฉันสังเกตเห็นฟังก์ชันนำเข้าในบุรุษไปรษณีย์: คำถามของฉันคือจะสร้างไฟล์ที่บุรุษไปรษณีย์ต้องการได้อย่างไร? ฉันไม่คุ้นเคยกับ Swagger

120 swagger  postman 

ฉันพยายามจะสื่อว่ารูปแบบการตรวจสอบความถูกต้อง / ความปลอดภัยต้องการการตั้งค่าส่วนหัวดังนี้: Authorization: Bearer <token> นี่คือสิ่งที่ฉันมีตามเอกสารของ Swagger : securityDefinitions: APIKey: type: apiKey name: Authorization in: header security: - APIKey: []

117 swagger  swagger-2.0  swagger-editor 

โครงการของฉันมี Spring Security ปัญหาหลัก: ไม่สามารถเข้าถึง URL ผยองที่http: // localhost: 8080 / API / v2 / API-เอกสาร มันขึ้นว่า Missing or invalid Authorization header ภาพหน้าจอของหน้าต่างเบราว์เซอร์ 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> </dependency> SwaggerConfig: @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new …

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

สำหรับ REST API บางตัวที่เขียนด้วย PHP ฉันถูกขอให้สร้างเอกสารSwaggerและเนื่องจากฉันไม่รู้วิธีง่ายๆในการเพิ่มคำอธิบายประกอบให้กับ API ที่มีอยู่เหล่านั้นและสร้างเอกสารดังกล่าวฉันจึงใช้ตัวแก้ไขนี้เพื่อสร้างบางส่วนในตอนนี้ ฉันบันทึกไฟล์ JSON และ YAML ที่สร้างโดยใช้โปรแกรมแก้ไขนั้นและตอนนี้ฉันต้องสร้างเอกสาร Swagger แบบโต้ตอบขั้นสุดท้าย (คำสั่งนี้อาจฟังดูไร้เดียงสาและคลุมเครือ) ใครช่วยบอกฉันหน่อยได้ไหมว่าฉันจะแปลงไฟล์ข้อมูลจำเพาะ Swagger JSON เป็นเอกสาร Swagger จริงได้อย่างไร ฉันอยู่บนแพลตฟอร์ม Windows และไม่รู้อะไรเกี่ยวกับ Ant / Maven

90 yaml  swagger  swagger-php 

ฉันมี ReSTFul API ที่เขียนด้วย Spring อย่างง่าย (ไม่มี Spring Boot ไม่มีของแฟนซี!) ฉันจำเป็นต้องใช้ Swagger ในสิ่งนี้ จนถึงตอนนี้ทุกหน้าบนอินเทอร์เน็ตทำให้ฉันคลั่งไคล้ด้วยการกำหนดค่าที่สับสนและรหัสที่บวมซึ่งฉันไม่พบแบบพกพาเลย ใครมีโครงการตัวอย่าง (หรือชุดขั้นตอนโดยละเอียด) ที่สามารถช่วยฉันทำสิ่งนี้ให้สำเร็จได้บ้าง? โดยเฉพาะอย่างยิ่งฉันกำลังมองหาตัวอย่างที่ดีที่ใช้ swagger-springmvc ฉันรู้ว่ามันมี 'ตัวอย่าง' แต่อย่างดีที่สุดรหัสลับก็ทำให้ท้อใจ ฉันต้องชี้แจงว่าฉันไม่ได้มองหา "ทำไม Swagger ถึงดีที่สุด" ฉันไม่ได้ใช้ (และสำหรับงานปัจจุบันของฉันจะไม่ใช้) Spring Boot หรืออื่น ๆ

85 spring  spring-mvc  swagger 

สองปีที่แล้วฉันทำงานกับ Spring Boot Applications กับ Springfox Springfox สร้างเอกสารและ Test UI สำหรับ REST API ของคุณ มันยอดเยี่ยมมาก แต่จริงๆแล้วโครงการ Springfox นั้นตายแล้วและไม่สนับสนุน Spring ตัวใหม่ ฉันมีสามคำถาม มีวิธีอื่นในการสร้าง Swagger UI โดยตรงหรือไม่ ห้องสมุด / โครงการอื่น ๆ คุณจะใช้ Swagger ui ในโครงการ Spring Boot ได้อย่างไร บางทีฉันอาจจะล้าสมัยไปแล้วมีทางเลือกอื่นที่ดีกว่านี้สำหรับพนักงานที่ทำงานใน Spring Boot หรือไม่? อัปเดต หลังจากหลายเดือนของการใช้งานหนักและการทดสอบของ SpringDoc OpenApi ฉันจะบอกว่านั่นไม่ใช่ทางเลือกของ springfox มันเป็นสิ่งที่ดีกว่ามาก! เสถียรใช้งานง่ายและทันสมัย! ฉันขอแนะนำได้ 100%! …

11 spring-boot  swagger  swagger-ui  springfox 

ฉันกำลังพัฒนา Web Api ด้วย. Net core 3.0 และต้องการรวมเข้ากับ 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 scheme. Example: \"Authorization: Bearer {token}\"", Name = "Authorization", …

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