O mnieOpen API

SwaggerSpringFox

Demo

Żywa dokumentacja RESTa

Krzysztof Pobożan

29 czerwca 2016

Krzysztof Pobożan Żywa dokumentacja RESTa

O mnieOpen API

SwaggerSpringFox

Demo

O mnie

Wieloletni programista PHP, a od 2 lat jako pro-gramista Java. Zwolennik SCRUMa i BDD.Email: krzpob@gmail.comGithub: https://github.com/krzpob

Krzysztof Pobożan Żywa dokumentacja RESTa

O mnieOpen API

SwaggerSpringFox

Demo

Agenda

1 Open API

2 Swagger

3 SpringFox

4 Demo

Krzysztof Pobożan Żywa dokumentacja RESTa

O mnieOpen API

SwaggerSpringFox

Demo

Open API

OAI - fundacja skupiająca się na rozwijaniu i promowaniu niezależnego formatuopisu API bazującego na specyfikacji Swagger. Strona domowa projektu OpenAPI Initiative

Rysunek: Członkowie

Krzysztof Pobożan Żywa dokumentacja RESTa

O mnieOpen API

SwaggerSpringFox

Demo

Specyfikacja

OpenAPI przejeło Swagger i rozwija go jako wersje 2.0https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md

Krzysztof Pobożan Żywa dokumentacja RESTa

O mnieOpen API

SwaggerSpringFox

Demo

Swagger

Prosta i silna reprezentacja RESTful API niezależna od językaPodstawowe narzędzia:

Swagger Codegen - generuje kod klienta. Dostępne jako plugin do mavena.

Swagger UI - dynamicznie generowany sandbox w HTML-uSwagger Editor - edycja API online

Krzysztof Pobożan Żywa dokumentacja RESTa

O mnieOpen API

SwaggerSpringFox

Demo

Swagger

Prosta i silna reprezentacja RESTful API niezależna od językaPodstawowe narzędzia:

Swagger Codegen - generuje kod klienta. Dostępne jako plugin do mavena.Swagger UI - dynamicznie generowany sandbox w HTML-u

Swagger Editor - edycja API online

Krzysztof Pobożan Żywa dokumentacja RESTa

O mnieOpen API

SwaggerSpringFox

Demo

Swagger

Prosta i silna reprezentacja RESTful API niezależna od językaPodstawowe narzędzia:

Swagger Codegen - generuje kod klienta. Dostępne jako plugin do mavena.Swagger UI - dynamicznie generowany sandbox w HTML-uSwagger Editor - edycja API online

Krzysztof Pobożan Żywa dokumentacja RESTa

O mnieOpen API

SwaggerSpringFox

Demo

Springfox.io

Url: http://springfox.github.io/springfox/ Maven - minimum 1 zależność +annotacja!

springfox-swagger2 - corespringfox-ui - klient REST w przeglądarce

Krzysztof Pobożan Żywa dokumentacja RESTa

O mnieOpen API

SwaggerSpringFox

Demo

Springfox.io

Url: http://springfox.github.io/springfox/ Maven - minimum 1 zależność +annotacja!springfox-swagger2 - corespringfox-ui - klient REST w przeglądarce

Krzysztof Pobożan Żywa dokumentacja RESTa

O mnieOpen API

SwaggerSpringFox

Demo

spring-restdocs

http://projects.spring.io/spring-restdocs/ Generuje wstawki z opisem API doużycia w ręcznie pisanej dokumentacji w asciidoc

Krzysztof Pobożan Żywa dokumentacja RESTa

O mnieOpen API

SwaggerSpringFox

Demo

DEMO

Krzysztof Pobożan Żywa dokumentacja RESTa