This is a java project to build a stand-alone server which implements the OpenAPI Spec. You can find out more about both the spec and the framework at http://swagger.io.
This sample creates an application context through the applicationContext.xml, allowing the JAXRSServerFactoryBean
to reflect over property packages to discover swagger-enabled resources.
To run the server, run this task:
mvn clean install
This will build a war file, then copy this one to {tomcat_home}/webapps
Once started, you can navigate to http://localhost:port/api/swagger.json to view the Swagger Resource Listing. This tells you that the server is up and ready to demonstrate Swagger.
There is an HTML5-based API tool bundled in this sample--you can view it it at [http://localhost:port] (http://localhost:8080). This lets you inspect the API using an interactive UI. You can access the source of this code from here
The sample app has an implementation of the Swagger ApiAuthorizationFilter. This restricts access to resources based on api-key. There are two keys defined in the sample app:
When no key is applied, the "default-key" is applied to all operations. If the "special-key" is entered, a number of other resources are shown in the UI, including sample CRUD operations.