org.zalando.stups:swagger-codegen-template-spring-interfaces-split

Parent pom.xml that can be used by STUPS Maven projects

License

License

Categories

Categories

Swagger Program Interface REST Frameworks
GroupId

GroupId

org.zalando.stups
ArtifactId

ArtifactId

swagger-codegen-template-spring-interfaces-split
Last Version

Last Version

0.5.0-beta-1
Release Date

Release Date

Type

Type

jar
Description

Description

Parent pom.xml that can be used by STUPS Maven projects
Project Organization

Project Organization

Zalando SE

Download swagger-codegen-template-spring-interfaces-split

How to add to project

<!-- https://jarcasting.com/artifacts/org.zalando.stups/swagger-codegen-template-spring-interfaces-split/ -->
<dependency>
    <groupId>org.zalando.stups</groupId>
    <artifactId>swagger-codegen-template-spring-interfaces-split</artifactId>
    <version>0.5.0-beta-1</version>
</dependency>
// https://jarcasting.com/artifacts/org.zalando.stups/swagger-codegen-template-spring-interfaces-split/
implementation 'org.zalando.stups:swagger-codegen-template-spring-interfaces-split:0.5.0-beta-1'
// https://jarcasting.com/artifacts/org.zalando.stups/swagger-codegen-template-spring-interfaces-split/
implementation ("org.zalando.stups:swagger-codegen-template-spring-interfaces-split:0.5.0-beta-1")
'org.zalando.stups:swagger-codegen-template-spring-interfaces-split:jar:0.5.0-beta-1'
<dependency org="org.zalando.stups" name="swagger-codegen-template-spring-interfaces-split" rev="0.5.0-beta-1">
  <artifact name="swagger-codegen-template-spring-interfaces-split" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.zalando.stups', module='swagger-codegen-template-spring-interfaces-split', version='0.5.0-beta-1')
)
libraryDependencies += "org.zalando.stups" % "swagger-codegen-template-spring-interfaces-split" % "0.5.0-beta-1"
[org.zalando.stups/swagger-codegen-template-spring-interfaces-split "0.5.0-beta-1"]

Dependencies

compile (2)

Group / Artifact Type Version
org.zalando.stups : swagger-codegen-common jar 0.5.0-beta-1
org.zalando.stups : swagger-codegen-template-spring-interfaces jar 0.5.0-beta-1

test (1)

Group / Artifact Type Version
junit : junit jar 4.11

Project Modules

There are no modules declared in this project.

Swagger-Codegen-Tooling

Build Status Javadoc Release Maven Central License

The project provides some tooling around Maven and Gradle* to generate code from OpenAPI-Specs. It comes with custom-templates to support Spring-MVC/Spring-Boot projects. Instead of generating code only once when a project starts (design phase), code will be generated at every build to make sure your code is in sync with your spec. So controllers/resources are generated as interfaces developers have to implement then. So changes in the spec should be reflected immediately on build/compile-step.

Getting started with Maven

To get started in a Maven project just add the following plugin-definition to you pom.xml.

    <plugin>
        <groupId>org.zalando.maven.plugins</groupId>
        <artifactId>swagger-codegen-maven-plugin</artifactId>
        <version>${version}</version>
        <configuration>
            <apiFile>${project.basedir}/src/main/resources/api.yaml</apiFile>
            <language>springinterfaces</language>
            <apiPackage>com.example.project.api</apiPackage>
            <modelPackage>com.example.project.model</modelPackage>
        </configuration>
        <executions>
            <execution>
                <id>swagger-codegen</id>
                <goals>
                    <goal>codegen</goal>
                </goals>
            </execution>
        </executions>
    </plugin>

According to your OpenAPI-spec (api.yaml) code will be generated in ${basedir}/target/generated-sources/swagger-codegen

More examples how to use the Maven-Plugin can be found in the integration-test section.

Development/Contribution

Build

The project itself uses Maven:

mvn clean install

Run with integration-tests enabled

mvn clean install -Pintegration

TODO's

API-SPEC

https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/3.0.md

Contributions

Many thanks to ePaul for reporting issues and code-contributions.

License

Copyright 2015-2017 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.

org.zalando.stups

STUPS by Zalando

THE PROJECTS IN THIS ORG ARE NO LONGER ACTIVELY MAINTAINED

Versions

Version
0.5.0-beta-1
0.4.38
0.4.37
0.4.36
0.4.35