swagger-ui Questions

4

I am using Swagger ui and Swagger core (1.3) for a jersey application. I have certain query parameters which I must send with every request like post, get, delete... How can I default this ?
Curacy asked 1/7, 2015 at 19:5

25

We have our Spring Boot services behind an API Gateway. With an earlier version of Springfox - 2.1.2 we had no issues in loading the swagger-ui.html page. This worked with Spring Boot 1.4.3.RELEASE...
Sybilsybila asked 7/3, 2018 at 15:20

7

Solved

I'm using springfox-swagger-ui 2.8.0 which ships with Swagger UI 3.7.0. I want to get rid of the controller list in front of the api documentation page, pretty useless for me (every tab is empty)....
Severson asked 8/5, 2018 at 8:52

6

I want to display two REST API endpoints in Swagger ui: /cart and /post. When I specify either /cart or /post works fine but with both showing me error as No operations defined in spec! in s...
Chamkis asked 11/5, 2018 at 11:26

2

I have used Swagger to generate a document for rest API, but I am building Kafka listener and wanted to generate a document for it. Do we have any possibility using Swagger or something simil...
Unswerving asked 22/2, 2018 at 15:31

3

I'm not able to display my spring doc in swagger-ui. This is my configuration : springdoc: # api-docs: # enabled: true # path: /v3/api-docs/swagger-config swagger-ui: # path: /swagger-ui.html ...
Oriel asked 14/4, 2022 at 7:57

6

Working on setting up swagger for a web application hosted with IIS using AspNetCore. The .json page loads and seems to be touching all the API just fine, however when navigating to {localhost}/swa...
Rucker asked 15/7, 2019 at 15:55

8

Solved

I am using Dotnet Core healthchecks as described here. In short, it looks like this: First, you configure services like this: services.AddHealthChecks() .AddSqlServer("connectionString",...
Cornerstone asked 25/1, 2019 at 9:21

6

Solved

My controller code is something like this. @Controller('customer') export class CustomerController{ constructor(private readonly customerService: CustomerService){} @Post('lookup') async som...
Tapioca asked 27/5, 2020 at 18:51

5

Solved

I created an API spec from some JSON files and I am trying to test if the files validate against the API spec. There are some good tools to validate against JSON Schema, but I did not have chance...
Telltale asked 1/9, 2016 at 15:49

2

I'm working on a REST API with a Swagger UI. When it comes time to expose the API, should I expose the Swagger UI as well? If so, how would I package it into my application. Currently, I have the U...
Accordingly asked 4/6, 2020 at 18:27

15

Solved

I'm currently using Swagger in my NestJS project, and I have the explorer enabled: in main.js const options = new DocumentBuilder() .setTitle('My App') .setSchemes('https') .setDescription('My A...
Audun asked 21/2, 2019 at 8:52

3

Solved

In the swaggerUI it's default takes the 'http' but the actual API will support the 'https' One possible way, will remove the 'http' in the schema, but in local unable to test the 'https' so what is...
Ladykiller asked 7/3, 2017 at 11:3

8

Solved

I am new to Swagger. I am using Swagger UI to generate swagger documentation. I have two API calls. First call is to generate token based on user name and password. Second call needs token generat...
Fort asked 30/10, 2015 at 11:48

3

Solved

my project is java spring boot 2 with maven . I use springdoc-openapi-ui dependency. problem is @Parameter(required = false) not working on my api params.

3

Solved

I want to add a documentation to my Node.js API, for this I have a YAML file where I put my definitions, the swagger doc is at localhost:5000/api-doc and working fine. Now I have to add Bearer auth...
Fidelfidela asked 28/4, 2020 at 9:36

2

Hope you can help me, here is the issue I have: Both of my frontend and backend servers runs on the same AWS EC2 instance. Because of this I have created a NGINX config like this: server { server_...
Maury asked 7/5, 2021 at 12:50

1

Solved

I have a FastAPI application for which I enable Authentication by injecting a dependency function. controller.py router = APIRouter( prefix="/v2/test", tags=["helloWorld"], depe...
Camail asked 3/5, 2023 at 0:25

33

Solved

Trying to setup swagger in conjunction with a web application hosted on IIS express. API is built using ASP Net Core. I have followed the instructions prescribed on the relevant microsoft help page...
Mini asked 2/7, 2019 at 20:24

3

Solved

I am new to FastAPI and I've been having this problem with importing my other files. I get the error:‍‍‍‍ from . import schemas ImportError: attempted relative import with no known parent package ...
Elemental asked 27/1, 2022 at 6:48

31

Is there a way to display all enums as their string value in swagger instead of their int value? I want to be able to submit POST actions and put enums according to their string value without hav...
Carbonado asked 6/4, 2016 at 13:22

4

I'm trying to add django-rest-swagger ui to my api, but I'm getting ImportError: No module named rest_framework_swagger even though I've already done pip install django-rest-swagger. I can also see...
Brownstone asked 9/12, 2014 at 0:7

3

Solved

One of my endpoints returns a JSON (not huge, around 2MB). Trying to run GET on this endpoint in swagger-ui results in the browser hanging for a few minutes. After this time, it finally displays th...
Genni asked 27/8, 2020 at 11:41

4

When I add springdoc-openapi-ui dependency to my pom.xml and run the application I get the exception in the title. When I remove this dependency everything works. Spring Boot version is 3.0.0 and s...
Enriquetaenriquez asked 13/12, 2022 at 17:35

3

Solved

@RequestMapping(...) public Foo getFoo(@HeaderParam("header") final String header) { ... } Adding a @HeaderParam method parameter as above springfox picks it up and when I look at the swagger-ui...
Porcia asked 12/4, 2016 at 23:3

© 2022 - 2024 — McMap. All rights reserved.