Questions tagged [swagger-jsdocs]
24 questions
0
votes
2 answers
Issues with Swagger Ui not displaying on browser
Here is Swagger has been setup in our backend and prior it was working just fine but today for certain unknown reasons I can't seem to figure out it stopped working and when we visit our endpoint locally we just get a blank page and the tab loader…
Chowa C
- 41
- 5
0
votes
2 answers
How to add a external key to Swagger response bodies
I am using swagger to create docs of a very simple express node API. All my response bodies have the follow format, using the "data" key:
{
"data": [items] // or a single item if it is the case
}
Right now, I'm using swagger-jsdoc to specify my…
Leonardo B. M.
- 15
- 6
0
votes
1 answer
how to use local swagger.json, istead of giving api controllers
I am new to swagger. I am creating an express-nodejs-typescript, rest api project. I have configured swagger and it is working fine, please see my code below.
import swaggerUi from "swagger-ui-express";
import swaggerJsdoc from 'swagger-jsdoc' …
raju
- 6,448
- 24
- 80
- 163
0
votes
1 answer
Swagger YAML not rendering
I am perplexed by my Swagger YAML file here that I am 99% sure is correct, but obviously it is not, but not sure where the issue could be:
/**
* @openapi
* components:
* schemas:
* ViewMedicationDto:
* type: array
* items:
* …
Daniel
- 14,004
- 16
- 96
- 156
0
votes
1 answer
How to arrange Endpoints and Categories in Swagger-jsdoc?
Is there a way to arrange API Categories and Endpoints in Swagger?
I'm using swagger-jsdoc and swagger-ui modules with Node.js.
Thanks!
Mitanshu
- 717
- 7
- 11
0
votes
1 answer
Can't require swagger-jsdoc
When I run the code it showing Must use import to load ES Module: error message. How can I solve this..?
error code: 'ERR_REQUIRE_ESM'
Tony George
- 116
- 14
0
votes
1 answer
swagger-jsdocs: YAMLException: bad indentation of a mapping entry
Need help swagger-jsdoc documentation. This is the first time I am working with. I get the following error for the below @swagger jsdoc documentation.
/**
* @swagger
* /v1/expected_rate/get_objects:
* get:
* description: Get objects for…
Techie Nerd
- 1
- 2
0
votes
0 answers
How to make the response example in Swagger UI match the actual response for application/application/vnd.api+json?
I have an API response which adheres to json-api spec of application/vnd.api+json. The response looks like this:
{
"jsonapi": {
"version": "1.0"
},
"data": {
"type": "drawDate",
"id": "1",
"attributes": {
…
Shree
- 59
- 1
- 4
-2
votes
1 answer
In Swagger with openapi 3.0, my nested object scheme is not being displayed
I'm working in a nodeJS project with express framework, i am using swagger-jsdoc and swagger-ui-express, also i'm writing my configuration in yaml file. I want to documents my services but i have some problems when i try to display nested objects.…
Paul R.
- 1
- 1