Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Issues
  • #6976
Closed
Open
Issue created Jul 17, 2020 by Administrator@rootContributor

[BUG][NODEJS] nodejs-express-server API docs path mapping inconsistencies

Created by: kmturley

Description

Swagger and OpenAPI usually expose API documentation at: /api-docs

Then approach is mirrored across your generators: https://github.com/OpenAPITools/openapi-generator/search?q=api-docs&unscoped_q=api-docs

However nodejs-express-server uses /api-doc this.app.use('/api-doc', swaggerUI.serve, swaggerUI.setup(this.schema)); https://github.com/OpenAPITools/openapi-generator/search?q=api-doc&unscoped_q=api-doc

Which is confusing because in the README.md it says /api-docs

  1. API documentation, and to check the available endpoints: http://localhost:3000/api-docs/
openapi-generator version

"@openapitools/openapi-generator-cli": "^1.0.15-4.3.1"

OpenAPI declaration file content or url

https://petstore.swagger.io/v2/swagger.yaml

Command line used for generation

npx @openapitools/openapi-generator-cli generate -i ./petstore.yaml -g nodejs-express-server -o ./src

Steps to reproduce
npm install @openapitools/openapi-generator-cli --save-dev
npx @openapitools/openapi-generator-cli list
npx @openapitools/openapi-generator-cli generate -i ./petstore.yaml -g nodejs-express-server -o ./src
cd src
npm install
npm start
Related issues/PRs

none

Suggest a fix

Update strings from /api-doc to /api-docs

Assignee
Assign to
Time tracking