Coder Social home page Coder Social logo

Comments (6)

lukeautry avatar lukeautry commented on April 28, 2024 4

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.

pleerock avatar pleerock commented on April 28, 2024

sounds good, would be great if we have such ability to generate docs right from the code

from tsoa.

amcdnl avatar amcdnl commented on April 28, 2024

@lukeautry I'm all for this, let me know how I can help!

from tsoa.

pleerock avatar pleerock commented on April 28, 2024

@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.

amcdnl avatar amcdnl commented on April 28, 2024

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.

lukeautry avatar lukeautry commented on April 28, 2024

Closing for now.

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.