Skip to content
This repository was archived by the owner on Feb 12, 2022. It is now read-only.

Add RAML 1.0 support to jaxrs-to-raml #212

Closed
18 tasks done
jstoiko opened this issue Nov 11, 2016 · 4 comments
Closed
18 tasks done

Add RAML 1.0 support to jaxrs-to-raml #212

jstoiko opened this issue Nov 11, 2016 · 4 comments
Assignees
Milestone

Comments

@jstoiko
Copy link
Contributor

jstoiko commented Nov 11, 2016

Work-in-progress: https://github.com/mulesoft/raml-for-jax-rs/tree/release/2.0.0

  • Extract relevant information from classes/code
  • Generate a __raml__ interface for each JAX-RS defined types
  • Generate RAML 1.0 from JAX-RS code (CLI)
  • Extracting JaxRs resources from a set of compiled classes
  • Support for @path classes and methods
  • Support for most HTTP verbs (HEAD, POST, GET, DELETE, PUT, OPTIONS)
  • Support for media types @consumes and @produces. The default media type is that of JaxRs and is listed as such in the RAML generated. Any method that has a different media type is explicitly declared as such and it is properly generated in the RAML.
  • Support for @QueryParam
  • Support for @PathParam
  • Support for @HeaderParam
  • Default values
  • Maven plugin that allows to parse compiled classes into RAML
  • CLI with same functionalities as the maven plugin
  • Support more than primitive types (complex objects) in return values
  • Support for @FormParam
  • Validations
  • Javadoc for descriptions
  • XML and Json stub generations -> Examples are generated as RAML data types
@jstoiko jstoiko added this to the 2.0.0 milestone Nov 11, 2016
@PhilLavoie
Copy link
Contributor

PhilLavoie commented Dec 22, 2016

Hi, I can't edit the above list so I'll just insert my own here :):

[list moved to the main description]

Nothing Swagger related is supported as of yet.

@jstoiko
Copy link
Contributor Author

jstoiko commented Dec 23, 2016

thanks @PhilLavoie!

@sichvoge
Copy link
Contributor

sichvoge commented Jan 9, 2017

@jstoiko the mapping for form parameters usually is a simple object type with properties.

@ujjwal-gupta
Copy link

What about support for Annotation types as per RAML Issue 174. Being able to mark an endpoint as deprecated is particularly useful.

@jstoiko jstoiko added the 2.0.x label Apr 20, 2017
@jstoiko jstoiko closed this as completed Apr 20, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

5 participants