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

what is api_key in swagger UI

I am new on Swagger , I am able to run swagger UI with spring . But I want to know what is api_key in swagger . What is use of api_key ? Could be search any api (rest controller in spring ) with api_key ? than how to configure that api with api_key…
Vijay
  • 4,694
  • 1
  • 30
  • 38
2
votes
2 answers

Swagger 2 (Spring fox) adds 'es' to my API's

I was just trying to integrate Swagger into my Spring Boot (JAX-RS) project built with Gradle.I was able to generate a docker (Swagger UI) for the same as following : I have configured my swagger with the default settings as follows : package…
CandleCoder
  • 1,387
  • 4
  • 21
  • 45
2
votes
1 answer

Changing Name and Description endpoint in Swagger-ui

I am using Spring boot and Spring Data Rest to implement my Rest API. To document it, I have been using Swagger, with these maven dependencies: io.springfox …
alonso_50
  • 1,442
  • 13
  • 16
2
votes
1 answer

Swashbuckle doesn't render HTML Swagger documentation properly anymore

I've got Web service methods which return the same HTTP response for different reasons, such as a 400 Bad Request for different qualities of posted data. I use Swashbuckle to generate the Swagger API documentation. Until recently, I used HTML…
Quality Catalyst
  • 6,531
  • 8
  • 38
  • 62
2
votes
1 answer

How to use ResourceOwnerPasswordCredentialsGrant with swagger ui

I am using swagger, swagger ui with spring rest api to get a platform for testing/documenting the API, so I need to get oAuth2 authorisation working in swagger ui, I am using password grant with the authorisation server, so I had to use…
Hasson
  • 1,894
  • 1
  • 21
  • 25
2
votes
1 answer

Where does swagger_yard place the JSON it generates?

Where does swagger_yard place the JSON file it generates? It doesn't say so in the README, https://github.com/livingsocial/swagger_yard I'm trying to point swagger-ui_rails to that JSON file.
Magne
  • 16,401
  • 10
  • 68
  • 88
2
votes
1 answer

Exclude complete services from swagger-ui with servicestack

I am trying to figure out a way to hide/remove complete services from the swagger-UI. According to the documentation on the servicestack swagger integration there should be a Exclude attribute. But unfortunately there is not. Is there maybe another…
zlZimon
  • 2,334
  • 4
  • 21
  • 51
2
votes
0 answers

swagger-ui not working in docker container

swagger-ui does not render when Spring Boot application is running in a docker container, only swagger.json. It works fine when running locally (IntelliJ). I'm not clear on how boot adds static resources to the fatjar. I tries several variations of…
zerayaqob
  • 426
  • 1
  • 6
  • 12
2
votes
0 answers

Swagger-UI: Protect Swagger-UI access

I am using a locally hosted Swagger UI on top of Node on an EC2 Ubuntu instance. Currently, in a browser when I type localhost:3000/myproject, I get the rendering, which basically pulls: http://localhost:3000/api-docs.json I would like to protect…
user1107173
  • 10,334
  • 16
  • 72
  • 117
2
votes
1 answer

Springfox Swagger generation creates odd schema

I am using Springfox-swagger to generate a Swagger page for my Spring Boot REST service. As a part of one of my POJOs that I serialise to JSON I use: javax.money.MonetaryAmount java.time.LocalDate The issue I'm seeing is that in Swagger, the Model…
kinbiko
  • 2,066
  • 1
  • 28
  • 40
2
votes
2 answers

Can I obtain the Swagger documentation from pre existing Java code?

I am absolutly new in Swagger and I have the following doubt: I know that gnerally I have to create Swagger document before code my REST API and the use this document to create my API (I know that from the Swagger Editor I can also generate my API…
AndreaNobili
  • 40,955
  • 107
  • 324
  • 596
2
votes
1 answer

How to extract parameters from an object to show in parameters in documentation

I have the following API endpoint: @ApiResponses( value = { @ApiResponse(code = 200, message = "OK", responseHeaders = { @ResponseHeader(name = "X-RateLimit-Limit", description = "The defined maximum number…
hatz
  • 225
  • 1
  • 4
  • 13
2
votes
1 answer

Spring REST / Swagger / Postman - Damaged/Blank File being dowloaded

I followed this post for the functionality: client can download a file(ie, csv,pdf and zip) as of now. But either I am getting pdf which is blank or when trying with zip file, it is coming as damaged. Only CSV works fine. I have checked the…
balboa_21
  • 375
  • 1
  • 7
  • 21
2
votes
3 answers

Specify swagger.json url for swagger UI wildfly swarm

I have REST application with Wildfly Swarm and using default settings I have swagger.json on url /swagger or /swagger.json and ui for swagger on url /swagger-ui. But UI parsing petstore from example by default. How is it possible to configure…
Nikita
  • 1,465
  • 3
  • 15
  • 17
2
votes
1 answer

Swagger UI for flask-potion based app

Is there a way to create Swagger-API UI documentation for a flask-potion based application? I've tried using "flasgger", but it doesn't work for routes that are written with potion-type routes. Flask-potion has a route specified in following manner-…
Priyansu Singh
  • 139
  • 10
1 2 3
…
99 100