{"repo":"ePages-de/restdocs-api-spec","free":true,"listed":false,"github":"https://github.com/ePages-de/restdocs-api-spec","clone":"git clone https://github.com/ePages-de/restdocs-api-spec.git","description":"Adds API specification support to Spring REST Docs","language":"Kotlin","stars":427,"topics":["spring-rest-docs","openapi","rest-api-documentation","spring","openapi-documentation"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"Spring REST Docs API specification Integration This is an extension that adds API specifications as an output format to Spring REST Docs. It currently supports: - OpenAPI 2.0 in json and yaml - OpenAPI 3.0.1 in json and yaml - Postman Collections 2.1.0 Please note that this extension was developed for JSON-based APIs. We do not expect this extension to build usable API specification for non-JSON request or response bodies. Motivation Spring REST Docs is a great tool to produce documentation for your RESTful services that is accurate and readable. We especially like its test-driven approach and this is the main reason why we chose it. It offers support for AsciiDoc and Markdown. This is great for generating simple HTML-based documentation. But both are markup languages and thus it is hard to get any further than statically generated HTML. API specifications like OpenAPI are a lot more flexible. With e.g. OpenAPI you get a machine-readable description of your API. There is a rich ecosystem around it that contains tools to: - generate a HTML representation of your API - ReDoc - generate an interactive API reference - e.g. using services like stoplight.io or readme.io Also, API specifications like OpenAPI are supported by many REST clients like Postman and Paw. Thus having an API specification for a REST API is a great plus when starting to work with it. The most common use case to generate an OpenAPI specification is code introspection and adding documentation related annotation","default_branch":null,"files":null,"tree":[],"storefront":"/r/ePages-de","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ePages-de/restdocs-api-spec/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}