API documentation with Spock and REST Assured in Spring Boot 2 app
Aim of the project is to show how to do API documentation generation with Spock and REST assured in Spring Boot 2 application. Whole idea is described in my blog post Code-Addict
API documentation is generated during build/tests process and provided in
Project is very simple and uses following dependencies:
- Spring Boot 2.1.1
- REST Assured http://rest-assured.io/
Just run using Spring Boot plugin command:
This will compile app and run Spock REST Assured tests which generate API docs.
Go to http://localhost:8080/docs/api.html and see how they looks.
Project uses a MIT licence .
Copyright (c) 2019 Michal Kostewicz
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.