Stack Overflow
Stack Overflow

Questions tagged [swagger]

Swagger is a framework implementation for describing, producing, consuming, and visualizing RESTful web services, based on the OpenAPI specification

Swagger is a specification and framework implementation for describing, producing, consuming and visualizing RESTful web services. It is a unique way to document your RESTful APIs on the go, as and when you code them.

The main advantage of Swagger is its flexibility - it can produce static and dynamic REST API documentation. There is even the possibility to interact with the webservice and send example queries.

It's developed by SmartBear.

On Nov 5th, 2015, the Open API Initiative extended Swagger as an OpenAPI specification to advance connected application development through open standards. Please refer to the announcement for more information.

Useful links

Frequently Asked Questions

People often ask about the following Swagger topics:

Related tags

11997 questions
5
votes
2 answers

Visual studio unable to add swagger metadata file in my rest api client

I am new to mobile development. As i am familiar with c# .net so i am using xamarin plugin for visual studio. I have created a sample app in which i have used SQLite, created a DB and then performed CRUD operations. At this point all things are…
Moeez
  • 494
  • 9
  • 55
  • 147
5
votes
2 answers

How to define Swagger 2.0 JSON to populate default body parameter object in Swagger UI?

Our current deployment patterns require me to manually write my swagger json output that will be consumed by the Swagger-based UI in use at my company. I'd like the json I'm writing to provide 'default' values to populate the Swagger UI for all…
Gabe
  • 119
  • 1
  • 3
  • 13
5
votes
0 answers

Enable Swagger with Jersey 2.0 using beanConfig

In jersy 2 application, I have the following configuration to setup swagger. @ApplicationPath("/*") public class CreativeDeliveryServiceApplication extends ResourceConfig { /** * Registers the resources for the application and binds implementations…
GingerJim
  • 3,737
  • 6
  • 26
  • 36
5
votes
0 answers

Using Swagger with Spring Boot and JWT

I run my app with Spring Boot using JWT token for authentication. I have a filter checks a token. Also my app provide rest API documentation with Swagger 2. I don't want my rest api will be public So my question is, how i can provide a security for…
Sergii Getman
  • 3,845
  • 5
  • 34
  • 50
5
votes
1 answer

Swashbuckle 5.4.0 with ASP.NET MVC WebApi - No documentation is shown inside the swagger webpage

I'm currently trying to use Swashbuckle 5.4.0 inside my ASP.NET MVC Web API application. Whenever I go to the swagger generated page (via rooturl/swagger) the page is correctly loaded, but no methods are shown. Comparing my project with another one…
Gab
  • 87
  • 3
  • 7
5
votes
1 answer

Python Flask: Go from Swagger YAML to Google App Engine?

I have used the Swagger Editor to create a REST API and I have requested the server code download for Python Flask. I'm trying to deploy this out to Google Cloud Platform (I think that's the latest name? Or is it still GAE?) but I need to fill in…
Unknown Coder
  • 6,625
  • 20
  • 79
  • 129
5
votes
2 answers

How to organise/build a Swagger UI interface for a directory which contains many Swagger definition .json/.yml files

I am trying to document, via Swagger UI, for internal company consumption, existing API services which are developed in a vendor product (WSO2 ESB). The vendor product does not support swagger. I plan to programmatically inspect/process the source…
MattG
  • 5,589
  • 5
  • 36
  • 52
5
votes
1 answer

Swagger Nested Array of Objects

i was asked to use swagger to describe the API and I struggle to get the more complex situations to work. Imagine you are posting Order with multiple order items d6a91238b0f17b49d49fbdcbba773d71 …
tomhre
  • 295
  • 1
  • 4
  • 15
5
votes
3 answers

Using generated Swagger TypeScript Rest Client in Angular2

I am working on a Meteor web application using Angular 2 and TypeScript. For using a REST API, I have generated client code with Swagger Codegen. Unfortunately there is no sample on GitHub, how to use the rest client. I have an angular 2 view…
Dolf
  • 101
  • 2
  • 8
5
votes
0 answers

@ApiImplicitParam for Map objects

I have a API which accepts One string, and One MAP as the input. public ModelClass getMyApi(String inparm, Map myValues) I am wondering how can i capture MAP input in swagger document using @ApiImplicitParams, @ApiImplicitParam…
Geek
  • 1,214
  • 5
  • 14
  • 27
5
votes
1 answer

C# Server Stub from swagger yaml

I want to generate C# server tub from swagger yaml file. Can anybody help me? Is there any tool to generate it? Thanks, Nishant
Nishant Agrawal
  • 102
  • 1
  • 7
5
votes
0 answers

How to add Basic authentication in springfox swagger2

Currently the swagger UI is exposed without any security scheme. Need to implement basic auth for the swagger UI. So that everytime its pops for username and password before displaying the UI. I have implemented ApiKey authorization but not able to…
Raunak Dugar
  • 247
  • 3
  • 14
5
votes
1 answer

Swagger Springfox Configuration Issue

I have an application that uses Spring MVC to handle REST calls, the Controllers are REST Controllers and annotated with @RestController, and the controller and its methods are annotated with @RequestMapping. I'm trying to add Swagger to generate…
Alex
  • 133
  • 1
  • 12
5
votes
1 answer

Can't get Django REST Swagger to work with routers

I have a Django REST Framework project and I'm trying to generate Swagger documentation. In my URL's file, however, I use a router and that doesn't seem to work very well with Swagger. I followed the instructions in this discussion and here's what I…
Ariel
  • 3,383
  • 4
  • 43
  • 58
5
votes
0 answers

Error handling in falcon middleware

I'm implementing swagger validation middleware for falcon framework. However, there's a problem with unsuccessful requests. If a falcon HTTP error is raised in responder or even before coming to a resource (for example in case of 404 Not Found),…
t_tia
  • 556
  • 1
  • 4
  • 17
1 2 3
…
99
100