Comments (2)
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.
@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)
- Can't Handle File and Non-File Field on multipart/form-data simultaneously HOT 4
- Can't Handle Optional File Field on multipart/form-data HOT 1
- Proposal/file upload configurations HOT 2
- UnknownType: IndexedAccessType error when using enum to index type object HOT 1
- The latest version 6.1.4 causes new build issues. HOT 10
- Middleware after response HOT 6
- After update 6.1.5 Types of property 'successStatus' are incompatible HOT 16
- Handling parameters that include mapped types with `Date` as a generic argument HOT 1
- ErrorHandlerMiddleware is ignore with 6.1.* HOT 11
- Populate causes error log: Debug Failure. False expression: Node must have a real position for this operation HOT 3
- ' HOT 1
- Treat null values as no value or undefined HOT 2
- jsdoc @example is used for union type but ignored for enum HOT 3
- programmatic way to generate the spec and routes HOT 12
- Custom parameters in controller
- Evaluate @Security in order of definition HOT 1
- AuthenticationMiddleware should also depend on authenticationModule being present HOT 1
- Unable to assign null to properties defined as number | null | undefined after updating to version 6.2.0 HOT 2
- Reasoning for always setting defaultNumberType HOT 1
- Can't send stream to injected error responder when using '@Security()` decorator. (Really I'm just trying to create a plain-text error) HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from tsoa.