Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/catalysts/swagger-jaxrs-maven-plugin

A thin wrapper allowing swagger-jaxrs spec file generation via a maven goal
https://github.com/catalysts/swagger-jaxrs-maven-plugin

Last synced: 18 days ago
JSON representation

A thin wrapper allowing swagger-jaxrs spec file generation via a maven goal

Awesome Lists containing this project

README

        

# swagger-jaxrs-maven-plugin

This maven plugin allows you to generate a swagger specification file via a maven goal.
It is only a thin wrapper around the swagger-jaxrs library, and uses its reader implementation.
For this reason please report any generation specific issues to the
[swagger-core issue tracker](https://github.com/swagger-api/swagger-core/issues) directly.

## Example usage

This is an example xml which shows a possible usage for using the swagger api.
It lists all possible configuration options with its default values:

```xml

4.0.0

swagger-jaxrs usage example
cc.catalysts
swagger-jaxrs-demo

1.0.0-SNAPSHOT




cc.catalysts
swagger-jaxrs-maven-plugin
1.0.0

${project.build.directory}/generated-resources/swagger-jaxrs
json,yaml
false





cc.catalysts
swagger-jaxrs-demo-api
1.0.0




generate-resources

swagger-jaxrs





```

## License

[MIT](https://opensource.org/licenses/MIT)