Comments (6)
For
2.x
, I'd love to have the examples adjusted to the advanced version aswell. Otherwise looking good!
Sure, will do! Examples + README.md included. Will also promisify everything for 2.x
.
from express-oas-generator.
@mpashkovskiy @kiprasmel Guys, after covering minor #72 the priorities for me would be:
Improving readme
- Removing basic usage
- Document advanced usage properly (
options
object args table: https://docs.github.com/en/github/writing-on-github/organizing-information-with-tables with columns name, required, type, description, default value) - Removing or moving down internal library functionality explanations
- @mpashkovskiy About npm readme, does it take the same README.md? Or we need to update it manually?
Refactor
- Remove basic usage example
- Updating tests with advanced usage.
- Updating
examples/with-jest
with advanced usage - Promisify instead of callbacks (Suggest to do that by the way). Use
async/await
. - Include prettier
After all that, we can finally deprecate init and ship 2.x
.
Let me know if you like the plan
from express-oas-generator.
Looks like we need support of [email protected]
from express-oas-generator.
For 2.x
, I'd love to have the examples adjusted to the advanced version aswell. Otherwise looking good!
from express-oas-generator.
looks good to me
from express-oas-generator.
@maxiejbe looks good to me! Let's remove the basic usage example right before we ship 2.x
but not earlier to avoid confusion.
from express-oas-generator.
Related Issues (20)
- Not working with my setup (express 5.0-alpha) HOT 2
- Did you support Sequelize ? HOT 4
- 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 HOT 1
- 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.