Stack Overflow
Stack Overflow

Questions tagged [swagger-ui]

Swagger UI is a collection of HTML, CSS and JavaScript objects that dynamically generate documentation from a Swagger-compliant API

Swagger UI is part of the Swagger project.

It adds form to your APIs by making them look good and presentable so that client code can be written easily, at the same time it also makes documentation easier by integrating it with code.

It originated out of the Open API Specification. The source can be found here.

A sample Swagger UI can be found at the Pet Store.

4353 questions
2
votes
1 answer

ServiceStack.Api.Swagger SwaggerResourcesService excluding Routes begining with Route Parameter

I am using Servicestack version 4.0.52.0 and ServiceStack.Api.Swagger 4.0.0.0 I have defined all routes with variable route parameter in serviceStack application host derived class(AppHostBase):Configure method public class AppHost : AppHostBase { …
Disham Parikh
  • 21
  • 2
2
votes
1 answer

swagger UI unable to process swagger.json that redoc is able to

I have the following simple swagger.json file. This is generated using go-swagger annotations for a golang service. I am able to get the UI page running with redoc. I want to display it with swagger-ui but I cannot get it to work. It shows an error…
Sakib
  • 1,503
  • 4
  • 26
  • 39
2
votes
2 answers

Generating Swagger documentation from existing REST api

Given an existing JAX-RS-annotated API that accepts & returns json, with jackson-annotated types, is there a way that I can generate some YAML Swagger documentation? My plan B is to write some code that uses reflection to find REST-annotated types,…
Val Akkapeddi
  • 1,173
  • 10
  • 17
2
votes
0 answers

C# Swagger\Swashbuckle Odata Web Api 2

Need some help. I've got swashbuckle\swagger working along with my webApi 2\Odata solution. However, I'm getting my routes for Gets and Deletes duplicated on the swagger display. It seems like swagger is interpreting my custom OData route and my web…
jaywebguy
  • 43
  • 6
2
votes
1 answer

How to implement Search function and Add Comments in Swagger

guys: I use swagger to make api document. I use ASP.NET WebAPI2 to develop WebAPI. And I met three questions: First: How could I Add Comments for the WebAPI Controller? I try to add Comment on Controller namespace IMCAPI.Controllers { ///…
K.Shuan
  • 21
  • 3
2
votes
2 answers

Adding Implementation Notes and Description to Swagger UI

I am attempting to add Implementation Notes and Description to my Swagger UI. However, neither show up on the UI when implemented as below: { "swagger" : "2.0", "info" : { "description" : "The definition of the Rest API to service plugin over…
SVN600
  • 345
  • 1
  • 5
  • 19
2
votes
1 answer

Test a Web API (aspnetcore) with Swagger UI and Azure AD B2C

I am a bit confused about things around Azure B2C auth for a Web API. I saw a lot of example to add a bearer token in the swagger UI. I think I understand that part. The Azure B2C environment and the Web API seem well configured with the "easy auth…
pellea
  • 359
  • 3
  • 21
2
votes
2 answers

Swagger UI returns "no content" in the Response Body, and Response Code 0

I'm newer to Swagger UI. I use swagger with Json. When the response is also Json. When clicking Try it Out, I see a correct Request URL, but the Swagger UI returns "no content" in the Response Body, and Response Code 0. Mentioned that API's URL is…
Jayesh
  • 4,755
  • 9
  • 32
  • 62
2
votes
1 answer

How to hide remove extra request body parameters in Swagger with Springfox

I have very big UserDto having many fields as below: public class UserDto implements Serializable { private Long id; @Column private String username; @Column private String emailId; @Column private String password; …
ilesh patel
  • 106
  • 1
  • 1
  • 5
2
votes
1 answer

Issues with using swagger with Django Rest Framework

I just started using swagger for my API documentation. I followed these docs , but more then half of the urls were excluded by swagger. As you can see in image below, it is showing some urls but few urls are excluded and the urls displayed by…
user5594493
  • 1,050
  • 3
  • 10
  • 24
2
votes
1 answer

Loading swagger-ui directory in jersey/jax-rs

Have a web application running in tomcat in a war file and as part of it I have jax-rs rest apis implemented with jax-rs and bound by jersey. These rest apis have some swagger annotations, however I cannot seem to get the swagger-ui to function…
user2524908
  • 861
  • 4
  • 18
  • 46
2
votes
1 answer

How to change the example values for api requests in Swagger UI?

I'm making an API for a site and I'm using Swagger UI, I currently have a route for adding a favorite for a user the route is "/users/{id}/favorites/", and the params in the spec are: "parameters":[ { "in":"path", …
jmona789
  • 2,711
  • 6
  • 24
  • 57
2
votes
0 answers

How do you properly use flask RequestParser and swagger-ui with multiple params of the same name?

I want to create a rest endpoint that allows multiple params of the same name, i.e. /api?param=a¶m=b I am using flask for the implementation and swagger-ui to create a nice ui where you can test the rest call. Here is what I have: from…
reikje
  • 2,850
  • 2
  • 24
  • 44
2
votes
1 answer

How to secure swagger page in rails?

In my project there is a documentation of API's by using swagger which URL is like http//www.example.com/api. Issue is that these are public and anyone can see that. I want to secure this link so that anyone can't see these API's. I see…
Haseeb Ahmad
  • 7,914
  • 12
  • 55
  • 133
2
votes
1 answer

Swagger UI - How to pass environment based URIs?

I have included the [dist] folder for Swagger UI in my Web API project. But when I go to this location http://localhost:1234/swagger it does not direct to http://localhost:1234/swagger/index.html automatically. So, when I access…
GilliVilla
  • 4,998
  • 11
  • 55
  • 96
1 2 3
…
99 100