Skip to content

nagyistge/twintip-spring-web

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Twintip Schema Discovery for Spring Web

Build Status Coverage Status Release Maven Central

Twintipify your Spring Web MVC application. This library exposes all the endpoints TWINTIP requires. See the documentation for TWINTIP.

Usage

First make sure that the endpoints are mapped into your application.

import org.zalando.twintip.spring.SchemaResource;

@Configuration
@Import(SchemaResource.class)
public class YourConfigration {
    // whatever you configure
}

Next you need to provide the API definition and decide where clients should find it. You can do this in your application.properties or application.yml.

twintip:
  mapping: /api
  yaml: "classpath:api.yml"

You are done.

Other options

SchemaResource will send CORS Access-Control-* headers by default. You can disable this by setting twintip.cors property to false.

Host, port, schemes and basePath inside of the API definition can be overridden by setting property twintip.baseUrl to full base URL of API.

License

Copyright [2015] Zalando SE

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

Twintipify your Spring Web MVC application

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 98.9%
  • Shell 1.1%