Comments (3)
Not to increase scope too much, but adding a minimum/maximum (with inclusive/exclusive boundary) for numerical values would also be useful. Some other properties at https://swagger.io/docs/specification/data-models/data-types/#range) may be good to consider.
from oatpp-swagger.
Adding the possibility to document minimum and maximum values would be really interesting.
The range is currently included in the OpenAPI json and is displayed by some tools. The default value does not look great:
from oatpp-swagger.
Hey @yeefan ,
- To add examples for an endpoint - see the description in this PR - #36
- Default values - are auto documented based on the default values set in the DTO
class MyDto { ... DTO_FIELD(String, myField) = "default value"; // <---the default value will be documented };
The Required property is a good point. We should think about how to add it
from oatpp-swagger.
Related Issues (20)
- No mapping for HTTP-method HOT 3
- CMake compiling with oatapp linking issues HOT 1
- Header parameters not shown in Swagger UI HOT 2
- missing cpack for module HOT 2
- Content-Type not set for CSS or JS responses HOT 2
- Error on start
- oatpp-swagger with HTTPS
- swagger-ui authorize bug
- To use "application/x-www-form-urlencoded" with readBodyDtoAsync HOT 1
- Set hosting base path
- Adding a Response with No Message Body Leads to an Oat++ Assertion Error at Runtime
- How To Describe File Type for `multipart/form-data` HOT 1
- The contact information cannot be an email. HOT 1
- bad interpretation of enum schemas
- Add authorization on the swagger controller
- Windows Support
- Crashed when added doc controller
- Access to raw OpenAPI JSON
- Problem with cmake FetchContent_* both oatpp-swagger and oatpp
- Support for schemas which better reflect DTO polymorphic fields
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 oatpp-swagger.