Comments (1)
@benmccann thank you for adding to the swagger-play readme. It is a nice thing for users of swagger and play to have multiple alternatives.
1, Thanks for letting us know about the routes parser PR, we can definitely use that.
2, Personally I like play's routes DSL and our developers are more familiar to it than swagger spec.
IMHO play routes DSL is more concise than the swagger spec equivalent when providing the basic information, e.g.
controllers.GN.createCard(profileId: Int, contextName: String)
v.s.
parameters: [
{ name: "profileId",
type: "integer",
format: "int32",
required: true
},
{ name: "contextName",
type: "string",
required: true
}
]
So that's less work for adding swagger to an existing play app, especially when you don't need to add a bunch of extra information than what the routes files already provide. In most cases all they need to add is a description and a respond and/or a request body ref.
I'm also a little concern over the number of layers of code generation in that approach, a swagger spec generating routes file than generate java routes classes. Could be hard to debug.
3, this library uses runtime reflection to the get the arguments list of the main constructor. I am certain it won't work with POJOs that lack a constructor with all fields. Not sure the other case. (sorry my java is even weaker than my scala), but I don't think it will be too hard to enhance it to work with POJOs.
from play-swagger.
Related Issues (20)
- Request parameters not visible in Swagger ui
- Open API spec generated is incorrect
- Swagger generating type zoneddatetime in the swagger json
- Support for Optional in schemas
- Swagger Custom Mappings not working with multiples parameters HOT 1
- array[byte] transforms to array-byte .Must transform string
- Swagger-ui compatibility HOT 4
- How to request a release? HOT 2
- Which PLAY versions must be supported? HOT 2
- Please release 0.11.0 HOT 2
- Allow passing classloader to DefinitionGenerator HOT 1
- Definitions description based on Scaladoc HOT 2
- Please Release 0.13.0
- Reusable enums are not working HOT 1
- Skip routes w/ no Swagger Spec comment HOT 1
- java.util.zip.ZipException: duplicate entry: public/swagger.json HOT 1
- Support Scala 3 HOT 2
- Wildcard matching for `swaggerDomainNameSpaces` HOT 1
- [Urgent] Deployment Failures of This Repository Since April. HOT 4
- Remove Swagger Json from Public Folder HOT 1
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 play-swagger.