Comments (4)
Hi @Afondevi,
The generation of the endpoint docs does not depend on the ORM, but in your incoming requests/responses.
You can check this issue first to see why the docs are not generated: #94
The disclaimer is that you won't get your models documented with Sequelize. For now the models generation is done only with Mongoose.
Let me know if that works.
Best,
from express-oas-generator.
Hi, Thanks but not understand your reponse.
I get no response and no response status documented, but I use return next()
on middleware.
I really don't understand how it works ^^
'
from express-oas-generator.
@Afondevi Please take a look at this comment: #94 (comment)
The library does not automagically document based on routes. You have to call the endpoint ("Try it out" in swagger, http clients like Postman, calling from a frontent, executing tests). Then it parses the request and the response, resulting in documenting the input/output.
Let me know if that helps. If it doesn't work, we need to review your library configuration, so a minimal reproduction example would be great.
from express-oas-generator.
Closing the issue. Feel free to reopen if there are still questions.
from express-oas-generator.
Related Issues (20)
- Not working with my setup (express 5.0-alpha) HOT 2
- Not fetching POST request body using typescript HOT 3
- Feature Suggestions
- [NodeJs16] DeprecationWarning: Invalid 'main' field HOT 3
- Is it possible to convert express request and response typescript definitions to openapi models? HOT 2
- Group routes HOT 1
- Body parameters not documented in Swagger doc by using express-oas-generator HOT 1
- URL auto conversion issue HOT 1
- Peer dependencies have high severity vulnerabilities
- Doesn't work while I am consuming APIs manually instead of jest test
- API specs lost if predefined spec includes an endpoint at `'/'` HOT 1
- /api-docs Route not found
- Is there any way to turn of producing swagger 2.0 .json file and only 3.0? HOT 1
- Deprecate call to handleRequests() HOT 8
- Question on request body HOT 9
- /api-docs route not found HOT 3
- Parameters and responses still not documented HOT 6
- typescript as dependency necessary? HOT 3
- Show Request Body contents HOT 5
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 express-oas-generator.