Fork me on GitHub

Minnal Api

Minnal has implemented Swagger specification for API documentation. You should be able to view your APIs from the Swagger UI.

Using Swagger UI

You can either download Swagger UI from here or hit http://swagger.wordnik.com/. In the text box, provide you application API url in the format http://localhost:8080/api/<application-name>/api-docs.json and hit enter. The application-name is the name you configured in your application config file under META-INF/

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
# The name of the application
name: shopping_cart

db:
  driverClass: com.mysql.jdbc.Driver
  url: jdbc:mysql://localhost/facilities
  username: root
  providerProperties:
    hibernate.ejb.naming_strategy: org.hibernate.cfg.ImprovedNamingStrategy
    hibernate.show_sql: true