Questions tagged [swagger]
Swagger is a cutting-edge tool designed to outline, generate, interact with, and display RESTful web services in accordance with the OpenAPI guidelines.
Looking for a method to extract and interpret data such as parameters from a Swagger file. Specifically, I am working with the Petstore Swagger API ( ). The definitions within the file contain references to other components, like parameters. One example ...
Currently, I am in the process of developing a Nestjs REST API project and need to integrate swagger. For reference, I followed this repository: https://github.com/nestjs/nest/tree/master/sample/11-swagger However, during the setup, I encountered the foll ...
I'm encountering an issue while attempting to upload multipart form data using multer. I have integrated swagger express middleware for my APIs. Strangely, everything was functioning correctly before implementing swagger. However, after integrating sw ...
I'm completely new to the world of node and swagger, so I decided to dive into loopback.io examples in order to build my own API. After successfully installing node and strongloop on my computer, I went ahead and created a fresh loopback application. I qu ...
Having an issue with the integration of the swagger-ui-express plugin in my node express REST API. When trying to bundle with webpack in production mode, I keep getting an error stating that SwaggerUIBundle is not defined. My app works fine without using w ...
Currently, I am involved in a project where we are managing version control of a .yml file that is crucial for defining our API. Unfortunately, there is no consistent linting standard in place because team members are using different editors and tools. I ...
Currently, I am utilizing the npm package called express-swagger-generator. When defining two routes as shown below: /** * @group Users - operations about user * @route GET /users * @route POST /users */ The issue arises where only the POST route is ...
I have created a compact service using flask and have also drafted a swagger yaml file to outline its API. What is the best way to make this swagger file accessible through the flask app? To clarify, I am not looking to directly expose the file itself (se ...
1. Overview: I successfully developed a basic application using Node.js, Express, and Swagger by following this informative tutorial, along with the help of generator-express-no-stress. However, when I attempt to run the application within a Docker contai ...
Is it possible to specify input parameters in Swagger with multiple types? For example: Consider an API that addresses resources using the URL http://localhost/tasks/{taskId}. However, each task contains both an integer ID and a string UUID. I would like ...
I'm currently working with a Joi model that looks like this: const SimpleModel = Joi.object({ id: Joi.number().integer().required().description('ID') }).label('SimpleModel'); This model is being utilized in the following route within @hapi/hapi: { ...
Seeking assistance in grasping the working of models in loopback4. Here's a model I defined: @model() export class ProductViewConfig extends BaseConfig { @property({ type: 'string', id: true, generated: true, }) _id?: strin ...
Looking to set up a nodejs-express boilerplate for my latest project, and this time I want to experiment with a doc-driven approach. Explored various packages like swagger-node, swaggerize-express ...and more, all offering excellent functionality. However ...
When testing Swagger locally, everything functions properly. However, after deploying the production version to my remote server, Swagger still appears at the URL /api-docs but throws an error stating "No operations defined in spec!" It no longer displays ...
Encountering an issue with NSwag in my Angular project where it throws an error when attempting to send data if the object contains a nested array of objects like this: export interface IJobAdDto { mainJobAd: JobAddDetailsDto; differentLanguageJobA ...
As a newcomer to swagger-node (swagger-spec 2.0), I am looking to have my API consume and produce both XML and JSON as requested by the customer. Currently, I have only focused on the "producing" aspect of it. When it comes to producing a response, I am a ...
Currently, I am working on a Typescripted nodejs server and facing an issue with defining different swagger paths for separated controllers. The problem is that the swagger-ui-express module only displays the last defined document in the specific route. I ...
Encountering TypeScript compiler errors related to rxjs while working with Angular 6 and Swagger Codegen: Cannot find module 'rxjs-compat/Observable' Referenced the following link for assistance: https://github.com/ReactiveX/rxjs/blob/master/MIGRATION.m ...
When generating the swagger.json using tsoa for TypeScript, I encountered an issue. Even after adding an access token to the authorize menu in Swagger and making a request to one of my endpoints, the x-access-token header is missing from the request. What ...
I'm currently working on a swagger node express app and I've run into a dilemma regarding the implementation of two security handlers. Within my swagger.yaml file, I have defined two SecurityDefinitions: securityDefinitions: appKeyA: type: apiKey ...
I developed a NodeJS and Swagger-based API that is functioning effectively, however, I am looking to limit access to only users with a valid API Key. What are the best practices for securing this API? Should I simply include the API key in the request or ...
I'm working with a Swagger YAML function that looks like this: /acitem/image: x-swagger-router-controller: image_send get: description: Returns 'image' to the caller operationId: imageSend parameters: - name: nam ...
swagger ui https://i.stack.imgur.com/UIavC.png I've been struggling to resolve this issue where the /swagger endpoint seems to only partially read the swagger.json file. Despite configuring everything correctly, no errors are appearing. It simply displays ...
After creating a front end with vite using vanilla javascript and setting up a backend with node.js express routes, I successfully integrated swagger for testing purposes. I have managed to enable functionalities such as logging in, logging out, and securi ...
I am currently working with the dropwizard framework on a project where I have implemented the @JsonSnakeCase annotation to convert CamelCase format to snake_case. However, when I attempt to generate swagger.json using swagger annotations, the definitions ...
Just recently started using Swagger and NodeJS, I successfully integrated Swagger into my NodeExpress application and generated typescript-client-code with Swagger-Codegen (specifically Typescript-Angular). However, the issue I am facing is that the gener ...
I'm encountering an issue while attempting to incorporate swagger into my NestJS application. The error message I am receiving is as follows: (node:78477) UnhandledPromiseRejectionWarning: TypeError: Cannot read property '0' of undefined at lodash_1.m ...
I'm currently working on a Spring Boot application that includes the following Rest function: @SecuredMaster @GetMapping(path = "/mitarbeiter") @Operation(security = {@SecurityRequirement(name = "jwt")}) public Page<MitarbeiterListRow> getMitar ...
Currently, I am in the process of developing a boilerplate NestJS application. My goal is to integrate @nestjs/swagger into the project. However, I have encountered an import error while trying to include the module. npm install --save @nestjs/<a href=" ...
Currently, I am exploring the idea of incorporating JSON-RPC into my web service using this particular library. Additionally, I am interested in integrating Swagger into my service as well. I find myself contemplating whether these two technologies work s ...
Our journey with Loopback has been successful thus far, but we are now looking to enhance our API documentation by including query parameters. In the swagger.json file, there could be a section that resembles this: { "swagger": "2.0", "i ...
I am currently working on a project using Symfony4 with api-platform. The login process is defined in security.yaml as follows: security: encoders: AppEntityUser: bcrypt providers: our_db_provider: entity: class: AppEntityU ...
I am currently exploring ways to document my API using the swagger generator tool called django-rest-swagger with DRF. At the moment, I am creating views by extending the rest_framework.views.APIView. I prefer not to use viewsets or serializers for writi ...
Utilizing Swagger, I have developed an API that allows my customers to access my service through URLs like: https://theservice.com/data/items/category1/12345 While this functionality works well, I am interested in creating a dedicated page where users ca ...
Lately, I have been working on a RESTful API that I recently created. However, knowing myself, I'll probably forget how to use it in a few months. To avoid this, I decided to document my API using Swagger, but little did I know the frustrations that would ...
I am having trouble setting up a post endpoint using swagger because the requestBody parameter is not being allowed: /names/{roster}: get: #... post: x-swagger-router-controller: names description: Add or remove names ope ...
I'm dealing with a metrics.controller.ts file that looks like this: import { Controller, Get } from '@nestjs/common'; import { ApiOperation, ApiResponse, ApiUseTags, ApiModelProperty } from '@nestjs/swagger'; import { PrometheusSe ...