Skip to content

MS3Inc/camel-restdsl-openapi-plugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

59 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Camel REST DSL OpenApi Maven Plugin

This is a custom Maven plugin, part of Tavros, for generating the REST DSL for projects generated using the OpenAPI Archetype. It is run automatically during the generation of the OpenAPI archetype.

According to the HTTP 1.1 specification RFC7231, certain HTTP methods do not have semantic definitions and therefore sending a payload body with such methods might cause some existing implementations to reject the request. OpenAPI 3.0.0 provides further guidance, specifying that a requestBody SHALL be ignored by consumers for these methods. This plugin will still generate code according to the OpenAPI document, but runtime support will depend on the HTTP server library used and all other components on the request path, such as proxies and gateways.

There is one goal associated with this plugin:

generate - To generate the REST DSL for both RoutesGenerated and RoutesImplementation classes.

How do I install the plugin locally?

Clone the main branch of this repo, change to the plugin directory, and run mvn clean install.

If you add or update a file and receive an error about missing headers, such as Missing header in: , run mvn com.mycila:license-maven-plugin:format. If you get an error with that command saying that you don't have the plugin locally, you can get it by running mvn org.apache.maven.plugins:maven-dependency-plugin:2.8:get -Dartifact=com.mycila:license-maven-plugin:4.0.rc2.

Who do I talk to?

Contact:

About

A plugin to be used by the OpenAPI archetype to generate the routes for RoutesGenerated and RoutesImplementation

Resources

License

Stars

Watchers

Forks

Languages