Swagger apioperation license#

The balance is up to the developer but for a reasonably-sized applicaiton organizing routes across various traits is probably a good idea. Despite losing the completeness of an entire api the result is a more modular application with a succint resource list. These traits with can then be joined together by their own route properties into a complete api. But because Swagger's annotation library requires classes, methods and fields to describe an Api, one may find it difficult to annotate a spray-routing application.Ī simple solution is to break apart a spray-routing application into various resource traits, with methods for specific api operations, joined by route concatentation into a route property. The routing dsl is an elegant way to describe an api and differs from the more common class and method approach of other frameworks. Spray-routing works by concatenating various routes, built up by directives, to produce an api.

Swagger apioperation license#

Val info = Info() //provides license and other description details Override val apiDocsPath = 'api-docs' //where you want the swagger-json endpoint exposed Override val basePath = '/' //the basePath for the API you are exposing Override val host = 'localhost:8080' //the url of your api, not swagger's json endpoint Override val apiTypes = Seq(typeOf, typeOf, typeOf) The routes property can be concatenated to your other route definitions: Here's an example SwaggerHttpService snippet which exposes Swagger's PetStore resources, Pet, User and Store. The SwaggerHttpService will inspect these annotations and build the appropriate Swagger response. These types include the appropriate Swagger annotations for describing your api. The service requires a set of apiTypes you want to expose via Swagger. This will expose an endpoint at // with the specified apiVersion, swaggerVersion and resource listing. The SwagerHttpService will contain a routes property you can concatenate along with your existing spray routes. It will generate the appropriate Swagger json schema based on a set of inputs declaring your Api and the types you want to expose. The SwaggerHttpService is a trait extending Spray's HttpService. It uses a PetHttpService and UserHttpService declared in the /samples folder. The /test directory includes an HttpSwaggerServiceSpec which leverages spray.testkit to test the API. Mhamrah/spray-swagger-sample is a spray api project with the original spray-swagger support and a Swagger UI. is a simple sample based on this project. If you need to older versions of Jackson, consider using swagger-spray 0.7.4. Swagger libraries depend heavily on Jackson. LibraryDependencies += '-spray' %% 'swagger-spray' % '0.8.0'