jfiala/swagger-spring-demo

Demo of Swagger & Spring & Swagger Codegen

Demo of Springfox Swagger-Spring Integration and Swagger-Codegen

Shows usage of the Springfox Swagger-Spring REST API and client code generation using Swagger-Codegen.

Projects

• Springfox Swagger-Spring Integration: https://github.com/springfox/springfox

• Swagger-Codegen: https://github.com/swagger-api/swagger-codegen

Open issues

for open issues regarding springfox/swagger-codegen see TODO Task list

IDE

Currently maven configuration files are supplied for all projects.

• Run Spring Boot Application: mvn spring-boot:run
• Generate Eclipse configuration: mvn eclipse:eclipse

user-rest-service-1.0.2 / Swagger 1.2

This uses the stable version 1.0.2 of Swagger-Spring Integration

• user-rest-service-1.0.2: Spring Boot Application

• user-rest-service-1.0.2-client-java-codegen-2.1.2-M1: Generated Java code using Swagger-Codegen

• user-rest-service-1.0.2-client-java-codegen-develop-2.0: Generated Java code using Swagger-Codegen using latest update

• user-rest-service-1.0.2-client-php-codegen-2.1.2-M1: Generated PHP code using Swagger-Codegen

• user-rest-service-1.0.2-client-php-codegen-develop-2.0: Generated PHP code using Swagger-Codegen using latest update

• user-rest-service-1.0.2-codegen-maven: Shows usage of the Swagger Codegen maven integration to generate PHP/Java code

user-rest-service-2.0.0 / Swagger 2.0.0 (SNAPSHOT)

Swagger 2.0.0 is currently under development, will always update to head

• user-rest-service-2.0.0: Spring Boot Application

• user-rest-service-2.0.0-client-java-codegen-2.1.2-M1: Generated Java code using Swagger-Codegen

• user-rest-service-2.0.0-client-java-codegen-develop-2.0: Generated Java code using Swagger-Codegen using latest update

Hot deployment

• Hot deployment using Spring-Loaded + JHipster-Core: -javaagent:C:/tools/spring-loaded/springloaded-1.2.3.RELEASE.jar -noverify-DhotReload.enabled=true

JHipster activation: HotReloadConfiguration.java

• sets target package

• default watchdir target/classes should be fine

• Refresh Swagger API changes (working for method-level refresh): http://localhost:8080/refresh (SpringSwaggerController)

The Refresh of the Swagger API changes is currently only provided for 1.0.2!

swagger-spring-demo's Issues

Add additional client stubs + tests for calling the UserApi/SearchApi

Todos for each language

1. Start up user-rest-service-1.0.2
2. Generate client stubs for the language using Swagger-Codegen, Branch develop-2.0
3. Add a simple test case calling the API
   • UserApi ==> UserApi_get_Test, UserApi_post_Test
   • UserResponseEntityApi ==> UserResponseEntityApi_Test
   • SearchApi ==> SearchApiTest
4. Add Assertions for alle the attributes at the UserApi (see GetUserTest.java:
   https://github.com/jfiala/swagger-spring-demo/blob/master/user-rest-service-1.0.2-client-java-codegen-develop-2.0/src/test/java/at/fwd/swagger/spring/demo/user/GetUserTest.java)
5. Send a PR for a new subproject: user-rest-service-1.0.2-client--codegen-develop-2.0
6. Redo 1-5 using user-rest-service-2.0.0
7. Check language as done below:

Tested Languages

i.e. Tests for 1.0.2 + 2.0.0 with Codegen develop-2.0 are supplied in the demo project

• Java
• PHP
• Android
• Async-Scala
• C#
• Groovy
• Jax-RS
• nodejs
• objc
• python
• ruby
• scala
• scalatra
• tizen

Add Selenium Swagger-UI Test cases

• Swagger-SpringMvc-1.0.2 (/)
• Swagger-SpringMvc-2.0.0 (/)

Useless user-rest-service-1.0.2-hateoas

What's the point of providing user-rest-service-1.0.2-hateoas if it doesn't really use hateoas properly?!

Add Swagger-ui as webjar as alternative to copying

see also: https://github.com/springfox/springfox
Swagger-UI
Option 1

Add gradle support (alternatively to Maven)

• Gradle Eclipse
• Gradle IDEA