Comments (4)
vanderlee
commented on June 19, 2024
I think that would be quite doable. Will look into it somewhere in the coming weeks.
Do you know if the SwaggerUI can handle examples.
from phpswaggergen.
oozolii
commented on June 19, 2024
Thank you very much! SwaggerUI can handle examples.
Check here in the example:
http://petstore.swagger.io/?_ga=2.136686704.1540059357.1509039902-598612444.1509039902
And here is the json for that: http://petstore.swagger.io/v2/swagger.json
The "example" shows up in the UI when you see eg. the "Add a new pet to the store" body options object.
from phpswaggergen.
vanderlee
commented on June 19, 2024
I've added support for example to all types and to the Response context.
Note that PHPSwaggerGen bases off the 2.0 spec. Relevant page on examples is here: https://swagger.io/docs/specification/2-0/adding-examples/.
The page you linked to was for OAS3. I may support 3.0 in the future, but currently have no plans to do so.
from phpswaggergen.
oozolii
commented on June 19, 2024
Thank you very much!
from phpswaggergen.
Related Issues (19)
- Model inside a model support in response definition HOT 5
- Support for string:uuid HOT 9
- object(xxxx:array(),xxxxx:array()) throws exception HOT 4
- Property definitions should accept further (type-specific) commands HOT 1
- HEAD operation is not supported HOT 3
- Multiple definitions exist for class TestCase HOT 1
- @rest/require should create object on each item HOT 1
- Suppress 'exclusive(Max|Min)imum' for unbounded range ends
- additionalProperties support HOT 5
- Comments ignored with docblock (/**) syntax HOT 3
- Preserve EOL to be able to format description HOT 2
- Insert content of preprocessor variable into documentation
- Associative arrays are cast to objects, not arrays HOT 2
- PHP Parser fails when parsing @rest\property! HOT 1
- PHP 8 error: array and string offset access with curly braces HOT 2
- Default string value with spaces
- parsing error in the example of Swagger documentation HOT 1
- Duplicate properties and parameters are output twice
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 phpswaggergen.