Coder Social home page Coder Social logo

Comments (2)

lukeautry avatar lukeautry commented on April 28, 2024 3

If something is part of the spec, then we should make it possible to define via configuration. This should be quite easy to do with a combination of changes in cli.ts and specGenerator.ts. A template is potentially an option, but if we can simply extend the CLI to include supported spec properties, that's my preference.

That said, looking at the example from the docs, the security portion of the spec can include quite a lot:

{
  "api_key": {
    "type": "apiKey",
    "name": "api_key",
    "in": "header"
  },
  "petstore_auth": {
    "type": "oauth2",
    "authorizationUrl": "http://swagger.io/api/oauth/dialog",
    "flow": "implicit",
    "scopes": {
      "write:pets": "modify pets in your account",
      "read:pets": "read your pets"
    }
  }
}

Passing all of that in via the CLI would be pretty gross. How would you feel about a tsoa.json configuration file allowing the customizable portions of the spec to be defined, allowing usage like this?

tsoa swagger --config=tsoa.json

from tsoa.

lukeautry avatar lukeautry commented on April 28, 2024

@andreasrueedlinger This has been implemented in the latest release (1.0.0). Note that this was a breaking change for the CLI.

Please check out the updated section of the readme for more information: https://github.com/lukeautry/tsoa#command-line-interface

Let me know if you run into any problems or have any questions.

from tsoa.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.