swagger-api/swagger-codegen

Tags in swagger yaml breaks nodejs generated server

Open

#2,423 opened on Mar 21, 2016

View on GitHub
 (17 comments) (1 reaction) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Issue: BugServer: Nodejshelp wanted

Description

I have been having a hard time using the generated nodejs server to build a mock API based on my swagger yaml file. It turns out that my use of tags in the yaml causes the generated server to have multiples of the controllers I am expecting.

If I add a single tag as follows:

      tags:
        - HTTP Request

Then when making an API request with the generated server I get the following error

Error: Cannot resolve the configured swagger-router handler: HTTP Request_shopsShopIdTransactionsGET

Removing the tag will allow the server to identify the correct controller and respond.

Contributor guide

Tech stack
nodejs
Domain
backendapi
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
understanding of OpenAPI/Swagger specbasic Node.js knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate how tags in the Swagger YAML affect the generated Node.js server code. The error indicates that the handler name is formed by concatenating tag and operation, e.g., 'HTTP Request shopsShopIdTransactionsGET'. Look at the template files for Node.js server generation in the swagger codegen repository, specifically how controller names and routes are generated. Check the comments on the issue for any hints about the expected behavior. The fix likely involves modifying the template to handle tags correctly, possibly by ignoring or using tags in a way that doesn't break the controller resolution.