Comments (6)
Frankly, I think @pleerock has a far more robust library for this - really the only thing it's missing (at least, from having looked at it) is swagger spec generation. With swagger spec generation on top, it's basically exactly what I'd want when starting to build out an API.
Since most of the work for swagger generation is parsing out the metadata and converting it to a spec, 90% of the logic is specific to the implementation, e.g. the conventions established in https://github.com/pleerock/routing-controllers. I might take a stab and open a pull request over there with spec generation, as I think it has more value coming as a single package, or at least an extension (e.g. routing-controllers-swagger).
from tsoa.
sounds good, would be great if we have such ability to generate docs right from the code
from tsoa.
@lukeautry I'm all for this, let me know how I can help!
from tsoa.
@lukeautry sounds very promising let me know too if there is something we need to do together to make this swagger spec generation part of routing-controllers
from tsoa.
Per discussion with @lukeautry...
yeah, i took a stab at it - the way that pleerock does metadata generation is different, it's using runtime reflection and currently object serialization for ts emitMetadata is not quite where it needs to be (that's why i had to actually run everything through the compiler)
i think with ts 2.0 object serialization is (probably?) finished so all swagger spec can be generated at runtime so, probably in the next couple months - for now i'm refining my solution as i like the simplicity of it
yeah, like basically having compiled typescript with decorators be able to output return types/argument type metadata e.g. return type is { id: string }, that metadata is written out to the compiled js somehow
Any feedback @pleerock ?
from tsoa.
Closing for now.
from tsoa.
Related Issues (20)
- Snyk security vulnerability for inflight (one of tsoa indirect dependencies) HOT 3
- Version 6.1.0 leads to missing packages, breaks existing builds HOT 20
- v6.1.0 breaking change on Authentication middleware HOT 1
- Using `Omit` causes extra model to be output in OpenAPI file HOT 2
- Cannot read properties of undefined (reading 'length') with @UploadedFile HOT 1
- Build error: Property 'name' is missing HOT 7
- 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
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.