diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/api.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/api.mustache index 5e33aefc1d3..8bc7a22fd76 100644 --- a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/api.mustache +++ b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/api.mustache @@ -22,6 +22,16 @@ import javax.validation.constraints.*; import javax.validation.Valid; {{/useBeanValidation}} +{{#appName}} +/** + * {{{appName}}} + * + {{#appDescription}} + *

{{{appDescription}}} + * + {{/appDescription}} + */ +{{/appName}} @Path("{{^useAnnotatedBasePath}}/{{/useAnnotatedBasePath}}{{#useAnnotatedBasePath}}{{contextPath}}{{/useAnnotatedBasePath}}") @Api(value = "/", description = "{{description}}") {{#addConsumesProducesJson}} @@ -32,6 +42,16 @@ public interface {{classname}} { {{#operations}} {{#operation}} + {{#summary}} + /** + * {{summary}} + * + {{#notes}} + * {{notes}} + * + {{/notes}} + */ + {{/summary}} @{{httpMethod}} {{#subresourceOperation}}@Path("{{{path}}}"){{/subresourceOperation}} {{#hasConsumes}} diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/apiServiceImpl.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/apiServiceImpl.mustache index d216ed02538..f677e3a835e 100644 --- a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/apiServiceImpl.mustache +++ b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/apiServiceImpl.mustache @@ -25,9 +25,29 @@ import org.springframework.stereotype.Service; {{/useSpringAnnotationConfig}} {{#description}} {{/description}} +{{#appName}} +/** + * {{{appName}}} + * + {{#appDescription}} + *

{{{appDescription}}} + {{/appDescription}} + * + */ +{{/appName}} public class {{classname}}ServiceImpl implements {{classname}} { {{#operations}} {{#operation}} + {{#summary}} + /** + * {{summary}} + * + {{#notes}} + * {{notes}} + * + {{/notes}} + */ + {{/summary}} public {{>returnTypes}} {{nickname}}({{#allParams}}{{>queryParamsImpl}}{{>pathParamsImpl}}{{>headerParamsImpl}}{{>bodyParamsImpl}}{{>formParamsImpl}}{{#hasMore}}, {{/hasMore}}{{/allParams}}) { // TODO: Implement... diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/api_test.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/api_test.mustache index d32c2e3a964..67a7db05386 100644 --- a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/api_test.mustache +++ b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/api_test.mustache @@ -42,7 +42,15 @@ import org.springframework.test.context.web.WebAppConfiguration; /** - * API tests for {{classname}} + {{#appName}} + * {{{appName}}} + * + {{/appName}} + {{#appDescription}} + *

{{{appDescription}}} + * + {{/appDescription}} + * API tests for {{classname}} */ {{#generateSpringBootApplication}} @RunWith(SpringJUnit4ClassRunner.class) @@ -91,10 +99,14 @@ public class {{classname}}Test { {{#operations}}{{#operation}} /** + {{#summary}} * {{summary}} * + {{#notes}} * {{notes}} * + {{/notes}} + {{/summary}} * @throws ApiException * if the Api call fails */ diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/pojo.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/pojo.mustache index bb9bbab729d..21d59768e7e 100644 --- a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/pojo.mustache +++ b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/pojo.mustache @@ -16,6 +16,9 @@ import javax.xml.bind.annotation.XmlEnumValue; {{^parent}}@XmlRootElement(name="{{classname}}"){{/parent}} {{/withXml}} {{#description}} +/** + * {{{description}}} + **/ @ApiModel(description="{{{description}}}") {{/description}} public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} { @@ -28,6 +31,11 @@ public class {{classname}} {{#parent}}extends {{{parent}}}{{/parent}} { @XmlElement(name="{{baseName}}"{{#required}}, required = {{required}}{{/required}}) {{/withXml}} @ApiModelProperty({{#example}}example = "{{{example}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}") +{{#description}} + /** + * {{{description}}} + **/ +{{/description}} private {{{datatypeWithEnum}}} {{name}} = {{{defaultValue}}};{{/vars}} {{#vars}} diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/pom.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/pom.mustache index df7a5a3bcb4..02c853a7559 100644 --- a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/pom.mustache +++ b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/pom.mustache @@ -4,6 +4,9 @@ {{artifactId}} jar {{artifactId}} + {{#appDescription}} + {{appDescription}} + {{/appDescription}} {{artifactVersion}} src/main/java diff --git a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/server/pom.mustache b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/server/pom.mustache index 2bc2739b1fe..c7be1d0b172 100644 --- a/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/server/pom.mustache +++ b/modules/swagger-codegen/src/main/resources/JavaJaxRS/cxf/server/pom.mustache @@ -4,6 +4,9 @@ {{artifactId}} war {{artifactId}} + {{#appDescription}} + {{appDescription}} + {{/appDescription}} {{artifactVersion}} src/main/java diff --git a/samples/client/petstore/jaxrs-cxf-client/pom.xml b/samples/client/petstore/jaxrs-cxf-client/pom.xml index 0c5cec23101..e2be3c4f26b 100644 --- a/samples/client/petstore/jaxrs-cxf-client/pom.xml +++ b/samples/client/petstore/jaxrs-cxf-client/pom.xml @@ -4,6 +4,7 @@ jaxrs-cxf-petstore-client war jaxrs-cxf-petstore-client + This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. 1.0.0 src/main/java diff --git a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/api/PetApi.java b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/api/PetApi.java index 93a82ed4f6c..f8b8a10d288 100644 --- a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/api/PetApi.java +++ b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/api/PetApi.java @@ -21,10 +21,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ @Path("/") @Api(value = "/", description = "") public interface PetApi { + /** + * Add a new pet to the store + * + * + * + */ @POST @Path("/pet") @Consumes({ "application/json", "application/xml" }) @@ -34,6 +46,12 @@ public interface PetApi { @ApiResponse(code = 405, message = "Invalid input") }) public void addPet(@Valid Pet body); + /** + * Deletes a pet + * + * + * + */ @DELETE @Path("/pet/{petId}") @Produces({ "application/xml", "application/json" }) @@ -42,6 +60,12 @@ public interface PetApi { @ApiResponse(code = 400, message = "Invalid pet value") }) public void deletePet(@PathParam("petId") Long petId, @HeaderParam("api_key") String apiKey); + /** + * Finds Pets by status + * + * Multiple status values can be provided with comma separated strings + * + */ @GET @Path("/pet/findByStatus") @Produces({ "application/xml", "application/json" }) @@ -51,6 +75,12 @@ public interface PetApi { @ApiResponse(code = 400, message = "Invalid status value") }) public List findPetsByStatus(@QueryParam("status") @NotNull List status); + /** + * Finds Pets by tags + * + * Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + * + */ @GET @Path("/pet/findByTags") @Produces({ "application/xml", "application/json" }) @@ -60,6 +90,12 @@ public interface PetApi { @ApiResponse(code = 400, message = "Invalid tag value") }) public List findPetsByTags(@QueryParam("tags") @NotNull List tags); + /** + * Find pet by ID + * + * Returns a single pet + * + */ @GET @Path("/pet/{petId}") @Produces({ "application/xml", "application/json" }) @@ -70,6 +106,12 @@ public interface PetApi { @ApiResponse(code = 404, message = "Pet not found") }) public Pet getPetById(@PathParam("petId") Long petId); + /** + * Update an existing pet + * + * + * + */ @PUT @Path("/pet") @Consumes({ "application/json", "application/xml" }) @@ -81,6 +123,12 @@ public interface PetApi { @ApiResponse(code = 405, message = "Validation exception") }) public void updatePet(@Valid Pet body); + /** + * Updates a pet in the store with form data + * + * + * + */ @POST @Path("/pet/{petId}") @Consumes({ "application/x-www-form-urlencoded" }) @@ -90,6 +138,12 @@ public interface PetApi { @ApiResponse(code = 405, message = "Invalid input") }) public void updatePetWithForm(@PathParam("petId") Long petId, @Multipart(value = "name", required = false) String name, @Multipart(value = "status", required = false) String status); + /** + * uploads an image + * + * + * + */ @POST @Path("/pet/{petId}/uploadImage") @Consumes({ "multipart/form-data" }) diff --git a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/api/StoreApi.java b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/api/StoreApi.java index 8ddeb8f3dea..72508ea286a 100644 --- a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/api/StoreApi.java +++ b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/api/StoreApi.java @@ -20,10 +20,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ @Path("/") @Api(value = "/", description = "") public interface StoreApi { + /** + * Delete purchase order by ID + * + * For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + * + */ @DELETE @Path("/store/order/{orderId}") @Produces({ "application/xml", "application/json" }) @@ -33,6 +45,12 @@ public interface StoreApi { @ApiResponse(code = 404, message = "Order not found") }) public void deleteOrder(@PathParam("orderId") String orderId); + /** + * Returns pet inventories by status + * + * Returns a map of status codes to quantities + * + */ @GET @Path("/store/inventory") @Produces({ "application/json" }) @@ -41,6 +59,12 @@ public interface StoreApi { @ApiResponse(code = 200, message = "successful operation", response = Map.class, responseContainer = "Map") }) public Map getInventory(); + /** + * Find purchase order by ID + * + * For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + * + */ @GET @Path("/store/order/{orderId}") @Produces({ "application/xml", "application/json" }) @@ -51,6 +75,12 @@ public interface StoreApi { @ApiResponse(code = 404, message = "Order not found") }) public Order getOrderById(@PathParam("orderId") @Min(1) @Max(5) Long orderId); + /** + * Place an order for a pet + * + * + * + */ @POST @Path("/store/order") @Produces({ "application/xml", "application/json" }) diff --git a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/api/UserApi.java b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/api/UserApi.java index 5588dddf74f..7aba6911b46 100644 --- a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/api/UserApi.java +++ b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/api/UserApi.java @@ -20,10 +20,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ @Path("/") @Api(value = "/", description = "") public interface UserApi { + /** + * Create user + * + * This can only be done by the logged in user. + * + */ @POST @Path("/user") @Produces({ "application/xml", "application/json" }) @@ -32,6 +44,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void createUser(@Valid User body); + /** + * Creates list of users with given input array + * + * + * + */ @POST @Path("/user/createWithArray") @Produces({ "application/xml", "application/json" }) @@ -40,6 +58,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void createUsersWithArrayInput(@Valid List body); + /** + * Creates list of users with given input array + * + * + * + */ @POST @Path("/user/createWithList") @Produces({ "application/xml", "application/json" }) @@ -48,6 +72,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void createUsersWithListInput(@Valid List body); + /** + * Delete user + * + * This can only be done by the logged in user. + * + */ @DELETE @Path("/user/{username}") @Produces({ "application/xml", "application/json" }) @@ -57,6 +87,12 @@ public interface UserApi { @ApiResponse(code = 404, message = "User not found") }) public void deleteUser(@PathParam("username") String username); + /** + * Get user by user name + * + * + * + */ @GET @Path("/user/{username}") @Produces({ "application/xml", "application/json" }) @@ -67,6 +103,12 @@ public interface UserApi { @ApiResponse(code = 404, message = "User not found") }) public User getUserByName(@PathParam("username") String username); + /** + * Logs user into the system + * + * + * + */ @GET @Path("/user/login") @Produces({ "application/xml", "application/json" }) @@ -76,6 +118,12 @@ public interface UserApi { @ApiResponse(code = 400, message = "Invalid username/password supplied") }) public String loginUser(@QueryParam("username") @NotNull String username, @QueryParam("password") @NotNull String password); + /** + * Logs out current logged in user session + * + * + * + */ @GET @Path("/user/logout") @Produces({ "application/xml", "application/json" }) @@ -84,6 +132,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void logoutUser(); + /** + * Updated user + * + * This can only be done by the logged in user. + * + */ @PUT @Path("/user/{username}") @Produces({ "application/xml", "application/json" }) diff --git a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Category.java b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Category.java index c6076fb8df8..0ab8c3ad003 100644 --- a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Category.java +++ b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Category.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * A category for a pet + **/ @ApiModel(description="A category for a pet") public class Category { diff --git a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/ModelApiResponse.java b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/ModelApiResponse.java index 4877f3ace31..a4298092c3f 100644 --- a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/ModelApiResponse.java +++ b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/ModelApiResponse.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * Describes the result of uploading an image resource + **/ @ApiModel(description="Describes the result of uploading an image resource") public class ModelApiResponse { diff --git a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Order.java b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Order.java index 5b4a67f50c1..8aa4664a01c 100644 --- a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Order.java +++ b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Order.java @@ -13,6 +13,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * An order for a pets from the pet store + **/ @ApiModel(description="An order for a pets from the pet store") public class Order { @@ -58,6 +61,9 @@ public static StatusEnum fromValue(String v) { } @ApiModelProperty(value = "Order Status") + /** + * Order Status + **/ private StatusEnum status = null; @ApiModelProperty(value = "") private Boolean complete = false; diff --git a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Pet.java b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Pet.java index 15f9322a95a..e8a79455f10 100644 --- a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Pet.java +++ b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Pet.java @@ -16,6 +16,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * A pet for sale in the pet store + **/ @ApiModel(description="A pet for sale in the pet store") public class Pet { @@ -63,6 +66,9 @@ public static StatusEnum fromValue(String v) { } @ApiModelProperty(value = "pet status in the store") + /** + * pet status in the store + **/ private StatusEnum status = null; /** diff --git a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Tag.java b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Tag.java index a0bfd24470f..8ee49279c31 100644 --- a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Tag.java +++ b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/Tag.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * A tag for a pet + **/ @ApiModel(description="A tag for a pet") public class Tag { diff --git a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/User.java b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/User.java index 74b908a3aa3..44dfc234041 100644 --- a/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/User.java +++ b/samples/client/petstore/jaxrs-cxf-client/src/gen/java/io/swagger/model/User.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * A User who is purchasing from the pet store + **/ @ApiModel(description="A User who is purchasing from the pet store") public class User { @@ -30,6 +33,9 @@ public class User { @ApiModelProperty(value = "") private String phone = null; @ApiModelProperty(value = "User Status") + /** + * User Status + **/ private Integer userStatus = null; /** diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/pom.xml b/samples/server/petstore/jaxrs-cxf-annotated-base-path/pom.xml index edaf8d0eeb7..0136d8f0a76 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/pom.xml +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/pom.xml @@ -4,6 +4,7 @@ swagger-cxf-annotated-basepath war swagger-cxf-annotated-basepath + This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. 1.0.0 src/main/java diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/api/PetApi.java b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/api/PetApi.java index f6551d8cc37..c576178bcc0 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/api/PetApi.java +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/api/PetApi.java @@ -21,10 +21,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ @Path("/v2") @Api(value = "/", description = "") public interface PetApi { + /** + * Add a new pet to the store + * + * + * + */ @POST @Path("/pet") @Consumes({ "application/json", "application/xml" }) @@ -34,6 +46,12 @@ public interface PetApi { @ApiResponse(code = 405, message = "Invalid input") }) public void addPet(@Valid Pet body); + /** + * Deletes a pet + * + * + * + */ @DELETE @Path("/pet/{petId}") @Produces({ "application/xml", "application/json" }) @@ -42,6 +60,12 @@ public interface PetApi { @ApiResponse(code = 400, message = "Invalid pet value") }) public void deletePet(@PathParam("petId") Long petId, @HeaderParam("api_key") String apiKey); + /** + * Finds Pets by status + * + * Multiple status values can be provided with comma separated strings + * + */ @GET @Path("/pet/findByStatus") @Produces({ "application/xml", "application/json" }) @@ -51,6 +75,12 @@ public interface PetApi { @ApiResponse(code = 400, message = "Invalid status value") }) public List findPetsByStatus(@QueryParam("status") @NotNull List status); + /** + * Finds Pets by tags + * + * Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + * + */ @GET @Path("/pet/findByTags") @Produces({ "application/xml", "application/json" }) @@ -60,6 +90,12 @@ public interface PetApi { @ApiResponse(code = 400, message = "Invalid tag value") }) public List findPetsByTags(@QueryParam("tags") @NotNull List tags); + /** + * Find pet by ID + * + * Returns a single pet + * + */ @GET @Path("/pet/{petId}") @Produces({ "application/xml", "application/json" }) @@ -70,6 +106,12 @@ public interface PetApi { @ApiResponse(code = 404, message = "Pet not found") }) public Pet getPetById(@PathParam("petId") Long petId); + /** + * Update an existing pet + * + * + * + */ @PUT @Path("/pet") @Consumes({ "application/json", "application/xml" }) @@ -81,6 +123,12 @@ public interface PetApi { @ApiResponse(code = 405, message = "Validation exception") }) public void updatePet(@Valid Pet body); + /** + * Updates a pet in the store with form data + * + * + * + */ @POST @Path("/pet/{petId}") @Consumes({ "application/x-www-form-urlencoded" }) @@ -90,6 +138,12 @@ public interface PetApi { @ApiResponse(code = 405, message = "Invalid input") }) public void updatePetWithForm(@PathParam("petId") Long petId, @Multipart(value = "name", required = false) String name, @Multipart(value = "status", required = false) String status); + /** + * uploads an image + * + * + * + */ @POST @Path("/pet/{petId}/uploadImage") @Consumes({ "multipart/form-data" }) diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/api/StoreApi.java b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/api/StoreApi.java index 0b00a353bc1..5e18529e1b5 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/api/StoreApi.java +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/api/StoreApi.java @@ -20,10 +20,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ @Path("/v2") @Api(value = "/", description = "") public interface StoreApi { + /** + * Delete purchase order by ID + * + * For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + * + */ @DELETE @Path("/store/order/{orderId}") @Produces({ "application/xml", "application/json" }) @@ -33,6 +45,12 @@ public interface StoreApi { @ApiResponse(code = 404, message = "Order not found") }) public void deleteOrder(@PathParam("orderId") String orderId); + /** + * Returns pet inventories by status + * + * Returns a map of status codes to quantities + * + */ @GET @Path("/store/inventory") @Produces({ "application/json" }) @@ -41,6 +59,12 @@ public interface StoreApi { @ApiResponse(code = 200, message = "successful operation", response = Map.class, responseContainer = "Map") }) public Map getInventory(); + /** + * Find purchase order by ID + * + * For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + * + */ @GET @Path("/store/order/{orderId}") @Produces({ "application/xml", "application/json" }) @@ -51,6 +75,12 @@ public interface StoreApi { @ApiResponse(code = 404, message = "Order not found") }) public Order getOrderById(@PathParam("orderId") @Min(1) @Max(5) Long orderId); + /** + * Place an order for a pet + * + * + * + */ @POST @Path("/store/order") @Produces({ "application/xml", "application/json" }) diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/api/UserApi.java b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/api/UserApi.java index 36a62cf2a0a..a5fd5adf01c 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/api/UserApi.java +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/api/UserApi.java @@ -20,10 +20,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ @Path("/v2") @Api(value = "/", description = "") public interface UserApi { + /** + * Create user + * + * This can only be done by the logged in user. + * + */ @POST @Path("/user") @Produces({ "application/xml", "application/json" }) @@ -32,6 +44,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void createUser(@Valid User body); + /** + * Creates list of users with given input array + * + * + * + */ @POST @Path("/user/createWithArray") @Produces({ "application/xml", "application/json" }) @@ -40,6 +58,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void createUsersWithArrayInput(@Valid List body); + /** + * Creates list of users with given input array + * + * + * + */ @POST @Path("/user/createWithList") @Produces({ "application/xml", "application/json" }) @@ -48,6 +72,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void createUsersWithListInput(@Valid List body); + /** + * Delete user + * + * This can only be done by the logged in user. + * + */ @DELETE @Path("/user/{username}") @Produces({ "application/xml", "application/json" }) @@ -57,6 +87,12 @@ public interface UserApi { @ApiResponse(code = 404, message = "User not found") }) public void deleteUser(@PathParam("username") String username); + /** + * Get user by user name + * + * + * + */ @GET @Path("/user/{username}") @Produces({ "application/xml", "application/json" }) @@ -67,6 +103,12 @@ public interface UserApi { @ApiResponse(code = 404, message = "User not found") }) public User getUserByName(@PathParam("username") String username); + /** + * Logs user into the system + * + * + * + */ @GET @Path("/user/login") @Produces({ "application/xml", "application/json" }) @@ -76,6 +118,12 @@ public interface UserApi { @ApiResponse(code = 400, message = "Invalid username/password supplied") }) public String loginUser(@QueryParam("username") @NotNull String username, @QueryParam("password") @NotNull String password); + /** + * Logs out current logged in user session + * + * + * + */ @GET @Path("/user/logout") @Produces({ "application/xml", "application/json" }) @@ -84,6 +132,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void logoutUser(); + /** + * Updated user + * + * This can only be done by the logged in user. + * + */ @PUT @Path("/user/{username}") @Produces({ "application/xml", "application/json" }) diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Category.java b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Category.java index c6076fb8df8..0ab8c3ad003 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Category.java +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Category.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * A category for a pet + **/ @ApiModel(description="A category for a pet") public class Category { diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/ModelApiResponse.java b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/ModelApiResponse.java index 4877f3ace31..a4298092c3f 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/ModelApiResponse.java +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/ModelApiResponse.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * Describes the result of uploading an image resource + **/ @ApiModel(description="Describes the result of uploading an image resource") public class ModelApiResponse { diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Order.java b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Order.java index 5b4a67f50c1..8aa4664a01c 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Order.java +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Order.java @@ -13,6 +13,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * An order for a pets from the pet store + **/ @ApiModel(description="An order for a pets from the pet store") public class Order { @@ -58,6 +61,9 @@ public static StatusEnum fromValue(String v) { } @ApiModelProperty(value = "Order Status") + /** + * Order Status + **/ private StatusEnum status = null; @ApiModelProperty(value = "") private Boolean complete = false; diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Pet.java b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Pet.java index 15f9322a95a..e8a79455f10 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Pet.java +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Pet.java @@ -16,6 +16,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * A pet for sale in the pet store + **/ @ApiModel(description="A pet for sale in the pet store") public class Pet { @@ -63,6 +66,9 @@ public static StatusEnum fromValue(String v) { } @ApiModelProperty(value = "pet status in the store") + /** + * pet status in the store + **/ private StatusEnum status = null; /** diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Tag.java b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Tag.java index a0bfd24470f..8ee49279c31 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Tag.java +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/Tag.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * A tag for a pet + **/ @ApiModel(description="A tag for a pet") public class Tag { diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/User.java b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/User.java index 74b908a3aa3..44dfc234041 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/User.java +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/gen/java/io/swagger/model/User.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * A User who is purchasing from the pet store + **/ @ApiModel(description="A User who is purchasing from the pet store") public class User { @@ -30,6 +33,9 @@ public class User { @ApiModelProperty(value = "") private String phone = null; @ApiModelProperty(value = "User Status") + /** + * User Status + **/ private Integer userStatus = null; /** diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/main/java/io/swagger/api/impl/PetApiServiceImpl.java b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/main/java/io/swagger/api/impl/PetApiServiceImpl.java index d9b9345d339..0f19eb3098d 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/main/java/io/swagger/api/impl/PetApiServiceImpl.java +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/main/java/io/swagger/api/impl/PetApiServiceImpl.java @@ -18,49 +18,103 @@ import io.swagger.annotations.Api; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ public class PetApiServiceImpl implements PetApi { + /** + * Add a new pet to the store + * + * + * + */ public void addPet(Pet body) { // TODO: Implement... } + /** + * Deletes a pet + * + * + * + */ public void deletePet(Long petId, String apiKey) { // TODO: Implement... } + /** + * Finds Pets by status + * + * Multiple status values can be provided with comma separated strings + * + */ public List findPetsByStatus(List status) { // TODO: Implement... return null; } + /** + * Finds Pets by tags + * + * Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + * + */ public List findPetsByTags(List tags) { // TODO: Implement... return null; } + /** + * Find pet by ID + * + * Returns a single pet + * + */ public Pet getPetById(Long petId) { // TODO: Implement... return null; } + /** + * Update an existing pet + * + * + * + */ public void updatePet(Pet body) { // TODO: Implement... } + /** + * Updates a pet in the store with form data + * + * + * + */ public void updatePetWithForm(Long petId, String name, String status) { // TODO: Implement... } + /** + * uploads an image + * + * + * + */ public ModelApiResponse uploadFile(Long petId, String additionalMetadata, Attachment fileDetail) { // TODO: Implement... diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/main/java/io/swagger/api/impl/StoreApiServiceImpl.java b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/main/java/io/swagger/api/impl/StoreApiServiceImpl.java index 3f791097b6b..9d3f93f8c3d 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/main/java/io/swagger/api/impl/StoreApiServiceImpl.java +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/main/java/io/swagger/api/impl/StoreApiServiceImpl.java @@ -17,25 +17,55 @@ import io.swagger.annotations.Api; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ public class StoreApiServiceImpl implements StoreApi { + /** + * Delete purchase order by ID + * + * For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + * + */ public void deleteOrder(String orderId) { // TODO: Implement... } + /** + * Returns pet inventories by status + * + * Returns a map of status codes to quantities + * + */ public Map getInventory() { // TODO: Implement... return null; } + /** + * Find purchase order by ID + * + * For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + * + */ public Order getOrderById(Long orderId) { // TODO: Implement... return null; } + /** + * Place an order for a pet + * + * + * + */ public Order placeOrder(Order body) { // TODO: Implement... diff --git a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/main/java/io/swagger/api/impl/UserApiServiceImpl.java b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/main/java/io/swagger/api/impl/UserApiServiceImpl.java index 861273cfb7b..c569dbf5c15 100644 --- a/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/main/java/io/swagger/api/impl/UserApiServiceImpl.java +++ b/samples/server/petstore/jaxrs-cxf-annotated-base-path/src/main/java/io/swagger/api/impl/UserApiServiceImpl.java @@ -17,49 +17,103 @@ import io.swagger.annotations.Api; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ public class UserApiServiceImpl implements UserApi { + /** + * Create user + * + * This can only be done by the logged in user. + * + */ public void createUser(User body) { // TODO: Implement... } + /** + * Creates list of users with given input array + * + * + * + */ public void createUsersWithArrayInput(List body) { // TODO: Implement... } + /** + * Creates list of users with given input array + * + * + * + */ public void createUsersWithListInput(List body) { // TODO: Implement... } + /** + * Delete user + * + * This can only be done by the logged in user. + * + */ public void deleteUser(String username) { // TODO: Implement... } + /** + * Get user by user name + * + * + * + */ public User getUserByName(String username) { // TODO: Implement... return null; } + /** + * Logs user into the system + * + * + * + */ public String loginUser(String username, String password) { // TODO: Implement... return null; } + /** + * Logs out current logged in user session + * + * + * + */ public void logoutUser() { // TODO: Implement... } + /** + * Updated user + * + * This can only be done by the logged in user. + * + */ public void updateUser(String username, User body) { // TODO: Implement... diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/pom.xml b/samples/server/petstore/jaxrs-cxf-non-spring-app/pom.xml index df55fcf5667..1c116b94ad1 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/pom.xml +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/pom.xml @@ -4,6 +4,7 @@ swagger-cxf-server-non-spring war swagger-cxf-server-non-spring + This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. 1.0.0 src/main/java diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/api/PetApi.java b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/api/PetApi.java index 93a82ed4f6c..f8b8a10d288 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/api/PetApi.java +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/api/PetApi.java @@ -21,10 +21,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ @Path("/") @Api(value = "/", description = "") public interface PetApi { + /** + * Add a new pet to the store + * + * + * + */ @POST @Path("/pet") @Consumes({ "application/json", "application/xml" }) @@ -34,6 +46,12 @@ public interface PetApi { @ApiResponse(code = 405, message = "Invalid input") }) public void addPet(@Valid Pet body); + /** + * Deletes a pet + * + * + * + */ @DELETE @Path("/pet/{petId}") @Produces({ "application/xml", "application/json" }) @@ -42,6 +60,12 @@ public interface PetApi { @ApiResponse(code = 400, message = "Invalid pet value") }) public void deletePet(@PathParam("petId") Long petId, @HeaderParam("api_key") String apiKey); + /** + * Finds Pets by status + * + * Multiple status values can be provided with comma separated strings + * + */ @GET @Path("/pet/findByStatus") @Produces({ "application/xml", "application/json" }) @@ -51,6 +75,12 @@ public interface PetApi { @ApiResponse(code = 400, message = "Invalid status value") }) public List findPetsByStatus(@QueryParam("status") @NotNull List status); + /** + * Finds Pets by tags + * + * Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + * + */ @GET @Path("/pet/findByTags") @Produces({ "application/xml", "application/json" }) @@ -60,6 +90,12 @@ public interface PetApi { @ApiResponse(code = 400, message = "Invalid tag value") }) public List findPetsByTags(@QueryParam("tags") @NotNull List tags); + /** + * Find pet by ID + * + * Returns a single pet + * + */ @GET @Path("/pet/{petId}") @Produces({ "application/xml", "application/json" }) @@ -70,6 +106,12 @@ public interface PetApi { @ApiResponse(code = 404, message = "Pet not found") }) public Pet getPetById(@PathParam("petId") Long petId); + /** + * Update an existing pet + * + * + * + */ @PUT @Path("/pet") @Consumes({ "application/json", "application/xml" }) @@ -81,6 +123,12 @@ public interface PetApi { @ApiResponse(code = 405, message = "Validation exception") }) public void updatePet(@Valid Pet body); + /** + * Updates a pet in the store with form data + * + * + * + */ @POST @Path("/pet/{petId}") @Consumes({ "application/x-www-form-urlencoded" }) @@ -90,6 +138,12 @@ public interface PetApi { @ApiResponse(code = 405, message = "Invalid input") }) public void updatePetWithForm(@PathParam("petId") Long petId, @Multipart(value = "name", required = false) String name, @Multipart(value = "status", required = false) String status); + /** + * uploads an image + * + * + * + */ @POST @Path("/pet/{petId}/uploadImage") @Consumes({ "multipart/form-data" }) diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/api/StoreApi.java b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/api/StoreApi.java index 8ddeb8f3dea..72508ea286a 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/api/StoreApi.java +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/api/StoreApi.java @@ -20,10 +20,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ @Path("/") @Api(value = "/", description = "") public interface StoreApi { + /** + * Delete purchase order by ID + * + * For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + * + */ @DELETE @Path("/store/order/{orderId}") @Produces({ "application/xml", "application/json" }) @@ -33,6 +45,12 @@ public interface StoreApi { @ApiResponse(code = 404, message = "Order not found") }) public void deleteOrder(@PathParam("orderId") String orderId); + /** + * Returns pet inventories by status + * + * Returns a map of status codes to quantities + * + */ @GET @Path("/store/inventory") @Produces({ "application/json" }) @@ -41,6 +59,12 @@ public interface StoreApi { @ApiResponse(code = 200, message = "successful operation", response = Map.class, responseContainer = "Map") }) public Map getInventory(); + /** + * Find purchase order by ID + * + * For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + * + */ @GET @Path("/store/order/{orderId}") @Produces({ "application/xml", "application/json" }) @@ -51,6 +75,12 @@ public interface StoreApi { @ApiResponse(code = 404, message = "Order not found") }) public Order getOrderById(@PathParam("orderId") @Min(1) @Max(5) Long orderId); + /** + * Place an order for a pet + * + * + * + */ @POST @Path("/store/order") @Produces({ "application/xml", "application/json" }) diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/api/UserApi.java b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/api/UserApi.java index 5588dddf74f..7aba6911b46 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/api/UserApi.java +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/api/UserApi.java @@ -20,10 +20,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ @Path("/") @Api(value = "/", description = "") public interface UserApi { + /** + * Create user + * + * This can only be done by the logged in user. + * + */ @POST @Path("/user") @Produces({ "application/xml", "application/json" }) @@ -32,6 +44,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void createUser(@Valid User body); + /** + * Creates list of users with given input array + * + * + * + */ @POST @Path("/user/createWithArray") @Produces({ "application/xml", "application/json" }) @@ -40,6 +58,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void createUsersWithArrayInput(@Valid List body); + /** + * Creates list of users with given input array + * + * + * + */ @POST @Path("/user/createWithList") @Produces({ "application/xml", "application/json" }) @@ -48,6 +72,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void createUsersWithListInput(@Valid List body); + /** + * Delete user + * + * This can only be done by the logged in user. + * + */ @DELETE @Path("/user/{username}") @Produces({ "application/xml", "application/json" }) @@ -57,6 +87,12 @@ public interface UserApi { @ApiResponse(code = 404, message = "User not found") }) public void deleteUser(@PathParam("username") String username); + /** + * Get user by user name + * + * + * + */ @GET @Path("/user/{username}") @Produces({ "application/xml", "application/json" }) @@ -67,6 +103,12 @@ public interface UserApi { @ApiResponse(code = 404, message = "User not found") }) public User getUserByName(@PathParam("username") String username); + /** + * Logs user into the system + * + * + * + */ @GET @Path("/user/login") @Produces({ "application/xml", "application/json" }) @@ -76,6 +118,12 @@ public interface UserApi { @ApiResponse(code = 400, message = "Invalid username/password supplied") }) public String loginUser(@QueryParam("username") @NotNull String username, @QueryParam("password") @NotNull String password); + /** + * Logs out current logged in user session + * + * + * + */ @GET @Path("/user/logout") @Produces({ "application/xml", "application/json" }) @@ -84,6 +132,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void logoutUser(); + /** + * Updated user + * + * This can only be done by the logged in user. + * + */ @PUT @Path("/user/{username}") @Produces({ "application/xml", "application/json" }) diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Category.java b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Category.java index c6076fb8df8..0ab8c3ad003 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Category.java +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Category.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * A category for a pet + **/ @ApiModel(description="A category for a pet") public class Category { diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/ModelApiResponse.java b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/ModelApiResponse.java index 4877f3ace31..a4298092c3f 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/ModelApiResponse.java +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/ModelApiResponse.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * Describes the result of uploading an image resource + **/ @ApiModel(description="Describes the result of uploading an image resource") public class ModelApiResponse { diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Order.java b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Order.java index 5b4a67f50c1..8aa4664a01c 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Order.java +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Order.java @@ -13,6 +13,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * An order for a pets from the pet store + **/ @ApiModel(description="An order for a pets from the pet store") public class Order { @@ -58,6 +61,9 @@ public static StatusEnum fromValue(String v) { } @ApiModelProperty(value = "Order Status") + /** + * Order Status + **/ private StatusEnum status = null; @ApiModelProperty(value = "") private Boolean complete = false; diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Pet.java b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Pet.java index 15f9322a95a..e8a79455f10 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Pet.java +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Pet.java @@ -16,6 +16,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * A pet for sale in the pet store + **/ @ApiModel(description="A pet for sale in the pet store") public class Pet { @@ -63,6 +66,9 @@ public static StatusEnum fromValue(String v) { } @ApiModelProperty(value = "pet status in the store") + /** + * pet status in the store + **/ private StatusEnum status = null; /** diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Tag.java b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Tag.java index a0bfd24470f..8ee49279c31 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Tag.java +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/Tag.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * A tag for a pet + **/ @ApiModel(description="A tag for a pet") public class Tag { diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/User.java b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/User.java index 74b908a3aa3..44dfc234041 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/User.java +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/gen/java/io/swagger/model/User.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * A User who is purchasing from the pet store + **/ @ApiModel(description="A User who is purchasing from the pet store") public class User { @@ -30,6 +33,9 @@ public class User { @ApiModelProperty(value = "") private String phone = null; @ApiModelProperty(value = "User Status") + /** + * User Status + **/ private Integer userStatus = null; /** diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/main/java/io/swagger/api/impl/PetApiServiceImpl.java b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/main/java/io/swagger/api/impl/PetApiServiceImpl.java index d9b9345d339..0f19eb3098d 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/main/java/io/swagger/api/impl/PetApiServiceImpl.java +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/main/java/io/swagger/api/impl/PetApiServiceImpl.java @@ -18,49 +18,103 @@ import io.swagger.annotations.Api; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ public class PetApiServiceImpl implements PetApi { + /** + * Add a new pet to the store + * + * + * + */ public void addPet(Pet body) { // TODO: Implement... } + /** + * Deletes a pet + * + * + * + */ public void deletePet(Long petId, String apiKey) { // TODO: Implement... } + /** + * Finds Pets by status + * + * Multiple status values can be provided with comma separated strings + * + */ public List findPetsByStatus(List status) { // TODO: Implement... return null; } + /** + * Finds Pets by tags + * + * Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + * + */ public List findPetsByTags(List tags) { // TODO: Implement... return null; } + /** + * Find pet by ID + * + * Returns a single pet + * + */ public Pet getPetById(Long petId) { // TODO: Implement... return null; } + /** + * Update an existing pet + * + * + * + */ public void updatePet(Pet body) { // TODO: Implement... } + /** + * Updates a pet in the store with form data + * + * + * + */ public void updatePetWithForm(Long petId, String name, String status) { // TODO: Implement... } + /** + * uploads an image + * + * + * + */ public ModelApiResponse uploadFile(Long petId, String additionalMetadata, Attachment fileDetail) { // TODO: Implement... diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/main/java/io/swagger/api/impl/StoreApiServiceImpl.java b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/main/java/io/swagger/api/impl/StoreApiServiceImpl.java index 3f791097b6b..9d3f93f8c3d 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/main/java/io/swagger/api/impl/StoreApiServiceImpl.java +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/main/java/io/swagger/api/impl/StoreApiServiceImpl.java @@ -17,25 +17,55 @@ import io.swagger.annotations.Api; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ public class StoreApiServiceImpl implements StoreApi { + /** + * Delete purchase order by ID + * + * For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + * + */ public void deleteOrder(String orderId) { // TODO: Implement... } + /** + * Returns pet inventories by status + * + * Returns a map of status codes to quantities + * + */ public Map getInventory() { // TODO: Implement... return null; } + /** + * Find purchase order by ID + * + * For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + * + */ public Order getOrderById(Long orderId) { // TODO: Implement... return null; } + /** + * Place an order for a pet + * + * + * + */ public Order placeOrder(Order body) { // TODO: Implement... diff --git a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/main/java/io/swagger/api/impl/UserApiServiceImpl.java b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/main/java/io/swagger/api/impl/UserApiServiceImpl.java index 861273cfb7b..c569dbf5c15 100644 --- a/samples/server/petstore/jaxrs-cxf-non-spring-app/src/main/java/io/swagger/api/impl/UserApiServiceImpl.java +++ b/samples/server/petstore/jaxrs-cxf-non-spring-app/src/main/java/io/swagger/api/impl/UserApiServiceImpl.java @@ -17,49 +17,103 @@ import io.swagger.annotations.Api; +/** + * Swagger Petstore + * + *

This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can use the api key `special-key` to test the authorization filters. + * + */ public class UserApiServiceImpl implements UserApi { + /** + * Create user + * + * This can only be done by the logged in user. + * + */ public void createUser(User body) { // TODO: Implement... } + /** + * Creates list of users with given input array + * + * + * + */ public void createUsersWithArrayInput(List body) { // TODO: Implement... } + /** + * Creates list of users with given input array + * + * + * + */ public void createUsersWithListInput(List body) { // TODO: Implement... } + /** + * Delete user + * + * This can only be done by the logged in user. + * + */ public void deleteUser(String username) { // TODO: Implement... } + /** + * Get user by user name + * + * + * + */ public User getUserByName(String username) { // TODO: Implement... return null; } + /** + * Logs user into the system + * + * + * + */ public String loginUser(String username, String password) { // TODO: Implement... return null; } + /** + * Logs out current logged in user session + * + * + * + */ public void logoutUser() { // TODO: Implement... } + /** + * Updated user + * + * This can only be done by the logged in user. + * + */ public void updateUser(String username, User body) { // TODO: Implement... diff --git a/samples/server/petstore/jaxrs-cxf/pom.xml b/samples/server/petstore/jaxrs-cxf/pom.xml index 3d7d56c8519..1ab75579100 100644 --- a/samples/server/petstore/jaxrs-cxf/pom.xml +++ b/samples/server/petstore/jaxrs-cxf/pom.xml @@ -4,6 +4,7 @@ swagger-cxf-server war swagger-cxf-server + This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ 1.0.0 src/main/java @@ -32,7 +33,7 @@ 8079 stopit - 8080 + 80 60000 diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/AnotherFakeApi.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/AnotherFakeApi.java index 3accd4f023e..c05c51bee51 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/AnotherFakeApi.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/AnotherFakeApi.java @@ -19,10 +19,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + * + */ @Path("/") @Api(value = "/", description = "") public interface AnotherFakeApi { + /** + * To test special tags + * + * To test special tags + * + */ @PATCH @Path("/another-fake/dummy") @Consumes({ "application/json" }) diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/FakeApi.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/FakeApi.java index 1e201b5f14d..190aceb4a5e 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/FakeApi.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/FakeApi.java @@ -23,6 +23,12 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + * + */ @Path("/") @Api(value = "/", description = "") public interface FakeApi { @@ -55,6 +61,12 @@ public interface FakeApi { @ApiResponse(code = 200, message = "Output string", response = String.class) }) public String fakeOuterStringSerialize(@Valid String body); + /** + * To test \"client\" model + * + * To test \"client\" model + * + */ @PATCH @Path("/fake") @Consumes({ "application/json" }) @@ -64,6 +76,12 @@ public interface FakeApi { @ApiResponse(code = 200, message = "successful operation", response = Client.class) }) public Client testClientModel(@Valid Client body); + /** + * Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + * + * Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + * + */ @POST @Path("/fake") @Consumes({ "application/xml; charset=utf-8", "application/json; charset=utf-8" }) @@ -74,6 +92,12 @@ public interface FakeApi { @ApiResponse(code = 404, message = "User not found") }) public void testEndpointParameters(@Multipart(value = "number") BigDecimal number, @Multipart(value = "double") Double _double, @Multipart(value = "pattern_without_delimiter") String patternWithoutDelimiter, @Multipart(value = "byte") byte[] _byte, @Multipart(value = "integer", required = false) Integer integer, @Multipart(value = "int32", required = false) Integer int32, @Multipart(value = "int64", required = false) Long int64, @Multipart(value = "float", required = false) Float _float, @Multipart(value = "string", required = false) String string, @Multipart(value = "binary", required = false) byte[] binary, @Multipart(value = "date", required = false) LocalDate date, @Multipart(value = "dateTime", required = false) Date dateTime, @Multipart(value = "password", required = false) String password, @Multipart(value = "callback", required = false) String paramCallback); + /** + * To test enum parameters + * + * To test enum parameters + * + */ @GET @Path("/fake") @Consumes({ "*/*" }) @@ -84,6 +108,12 @@ public interface FakeApi { @ApiResponse(code = 404, message = "Not found") }) public void testEnumParameters(@Multipart(value = "enum_form_string_array", required = false) List enumFormStringArray, @Multipart(value = "enum_form_string", required = false) String enumFormString, @HeaderParam("enum_header_string_array") List enumHeaderStringArray, @HeaderParam("enum_header_string") String enumHeaderString, @QueryParam("enum_query_string_array") List enumQueryStringArray, @QueryParam("enum_query_string") @DefaultValue("-efg") String enumQueryString, @QueryParam("enum_query_integer") Integer enumQueryInteger, @Multipart(value = "enum_query_double", required = false) Double enumQueryDouble); + /** + * test json serialization of form data + * + * + * + */ @GET @Path("/fake/jsonFormData") @Consumes({ "application/json" }) diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/FakeClassnameTags123Api.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/FakeClassnameTags123Api.java index 021e7eeb91f..63de6839dc1 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/FakeClassnameTags123Api.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/FakeClassnameTags123Api.java @@ -19,10 +19,20 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + * + */ @Path("/") @Api(value = "/", description = "") public interface FakeClassnameTags123Api { + /** + * To test class name in snake case + * + */ @PATCH @Path("/fake_classname_test") @Consumes({ "application/json" }) diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/PetApi.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/PetApi.java index 93a82ed4f6c..20fab16db0c 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/PetApi.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/PetApi.java @@ -21,10 +21,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + * + */ @Path("/") @Api(value = "/", description = "") public interface PetApi { + /** + * Add a new pet to the store + * + * + * + */ @POST @Path("/pet") @Consumes({ "application/json", "application/xml" }) @@ -34,6 +46,12 @@ public interface PetApi { @ApiResponse(code = 405, message = "Invalid input") }) public void addPet(@Valid Pet body); + /** + * Deletes a pet + * + * + * + */ @DELETE @Path("/pet/{petId}") @Produces({ "application/xml", "application/json" }) @@ -42,6 +60,12 @@ public interface PetApi { @ApiResponse(code = 400, message = "Invalid pet value") }) public void deletePet(@PathParam("petId") Long petId, @HeaderParam("api_key") String apiKey); + /** + * Finds Pets by status + * + * Multiple status values can be provided with comma separated strings + * + */ @GET @Path("/pet/findByStatus") @Produces({ "application/xml", "application/json" }) @@ -51,6 +75,12 @@ public interface PetApi { @ApiResponse(code = 400, message = "Invalid status value") }) public List findPetsByStatus(@QueryParam("status") @NotNull List status); + /** + * Finds Pets by tags + * + * Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + * + */ @GET @Path("/pet/findByTags") @Produces({ "application/xml", "application/json" }) @@ -60,6 +90,12 @@ public interface PetApi { @ApiResponse(code = 400, message = "Invalid tag value") }) public List findPetsByTags(@QueryParam("tags") @NotNull List tags); + /** + * Find pet by ID + * + * Returns a single pet + * + */ @GET @Path("/pet/{petId}") @Produces({ "application/xml", "application/json" }) @@ -70,6 +106,12 @@ public interface PetApi { @ApiResponse(code = 404, message = "Pet not found") }) public Pet getPetById(@PathParam("petId") Long petId); + /** + * Update an existing pet + * + * + * + */ @PUT @Path("/pet") @Consumes({ "application/json", "application/xml" }) @@ -81,6 +123,12 @@ public interface PetApi { @ApiResponse(code = 405, message = "Validation exception") }) public void updatePet(@Valid Pet body); + /** + * Updates a pet in the store with form data + * + * + * + */ @POST @Path("/pet/{petId}") @Consumes({ "application/x-www-form-urlencoded" }) @@ -90,6 +138,12 @@ public interface PetApi { @ApiResponse(code = 405, message = "Invalid input") }) public void updatePetWithForm(@PathParam("petId") Long petId, @Multipart(value = "name", required = false) String name, @Multipart(value = "status", required = false) String status); + /** + * uploads an image + * + * + * + */ @POST @Path("/pet/{petId}/uploadImage") @Consumes({ "multipart/form-data" }) diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/StoreApi.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/StoreApi.java index 2698ca445e6..065420cf357 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/StoreApi.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/StoreApi.java @@ -20,10 +20,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + * + */ @Path("/") @Api(value = "/", description = "") public interface StoreApi { + /** + * Delete purchase order by ID + * + * For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + * + */ @DELETE @Path("/store/order/{order_id}") @Produces({ "application/xml", "application/json" }) @@ -33,6 +45,12 @@ public interface StoreApi { @ApiResponse(code = 404, message = "Order not found") }) public void deleteOrder(@PathParam("order_id") String orderId); + /** + * Returns pet inventories by status + * + * Returns a map of status codes to quantities + * + */ @GET @Path("/store/inventory") @Produces({ "application/json" }) @@ -41,6 +59,12 @@ public interface StoreApi { @ApiResponse(code = 200, message = "successful operation", response = Map.class, responseContainer = "Map") }) public Map getInventory(); + /** + * Find purchase order by ID + * + * For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + * + */ @GET @Path("/store/order/{order_id}") @Produces({ "application/xml", "application/json" }) @@ -51,6 +75,12 @@ public interface StoreApi { @ApiResponse(code = 404, message = "Order not found") }) public Order getOrderById(@PathParam("order_id") @Min(1) @Max(5) Long orderId); + /** + * Place an order for a pet + * + * + * + */ @POST @Path("/store/order") @Produces({ "application/xml", "application/json" }) diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/UserApi.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/UserApi.java index 5588dddf74f..3e0d6350623 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/UserApi.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/api/UserApi.java @@ -20,10 +20,22 @@ import javax.validation.constraints.*; import javax.validation.Valid; +/** + * Swagger Petstore + * + *

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + * + */ @Path("/") @Api(value = "/", description = "") public interface UserApi { + /** + * Create user + * + * This can only be done by the logged in user. + * + */ @POST @Path("/user") @Produces({ "application/xml", "application/json" }) @@ -32,6 +44,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void createUser(@Valid User body); + /** + * Creates list of users with given input array + * + * + * + */ @POST @Path("/user/createWithArray") @Produces({ "application/xml", "application/json" }) @@ -40,6 +58,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void createUsersWithArrayInput(@Valid List body); + /** + * Creates list of users with given input array + * + * + * + */ @POST @Path("/user/createWithList") @Produces({ "application/xml", "application/json" }) @@ -48,6 +72,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void createUsersWithListInput(@Valid List body); + /** + * Delete user + * + * This can only be done by the logged in user. + * + */ @DELETE @Path("/user/{username}") @Produces({ "application/xml", "application/json" }) @@ -57,6 +87,12 @@ public interface UserApi { @ApiResponse(code = 404, message = "User not found") }) public void deleteUser(@PathParam("username") String username); + /** + * Get user by user name + * + * + * + */ @GET @Path("/user/{username}") @Produces({ "application/xml", "application/json" }) @@ -67,6 +103,12 @@ public interface UserApi { @ApiResponse(code = 404, message = "User not found") }) public User getUserByName(@PathParam("username") String username); + /** + * Logs user into the system + * + * + * + */ @GET @Path("/user/login") @Produces({ "application/xml", "application/json" }) @@ -76,6 +118,12 @@ public interface UserApi { @ApiResponse(code = 400, message = "Invalid username/password supplied") }) public String loginUser(@QueryParam("username") @NotNull String username, @QueryParam("password") @NotNull String password); + /** + * Logs out current logged in user session + * + * + * + */ @GET @Path("/user/logout") @Produces({ "application/xml", "application/json" }) @@ -84,6 +132,12 @@ public interface UserApi { @ApiResponse(code = 200, message = "successful operation") }) public void logoutUser(); + /** + * Updated user + * + * This can only be done by the logged in user. + * + */ @PUT @Path("/user/{username}") @Produces({ "application/xml", "application/json" }) diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Capitalization.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Capitalization.java index 8d25cc55cb3..349037a73b6 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Capitalization.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Capitalization.java @@ -24,6 +24,9 @@ public class Capitalization { @ApiModelProperty(value = "") private String scAETHFlowPoints = null; @ApiModelProperty(value = "Name of the pet ") + /** + * Name of the pet + **/ private String ATT_NAME = null; /** diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/ClassModel.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/ClassModel.java index 9f4a079d27a..65a339a0d67 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/ClassModel.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/ClassModel.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * Model for testing model with \"_class\" property + **/ @ApiModel(description="Model for testing model with \"_class\" property") public class ClassModel { diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Model200Response.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Model200Response.java index 1f2a89db5d3..ae9d21149a0 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Model200Response.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Model200Response.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * Model for testing model name starting with number + **/ @ApiModel(description="Model for testing model name starting with number") public class Model200Response { diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/ModelReturn.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/ModelReturn.java index 3a56f9c8683..451fb5bc7c4 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/ModelReturn.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/ModelReturn.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * Model for testing reserved words + **/ @ApiModel(description="Model for testing reserved words") public class ModelReturn { diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Name.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Name.java index d5edcadd585..963987418fd 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Name.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Name.java @@ -12,6 +12,9 @@ import javax.xml.bind.annotation.XmlEnum; import javax.xml.bind.annotation.XmlEnumValue; +/** + * Model for testing model name same as property name + **/ @ApiModel(description="Model for testing model name same as property name") public class Name { diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Order.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Order.java index c479b33bc35..4a7dacbbfe5 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Order.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Order.java @@ -56,6 +56,9 @@ public static StatusEnum fromValue(String v) { } @ApiModelProperty(value = "Order Status") + /** + * Order Status + **/ private StatusEnum status = null; @ApiModelProperty(value = "") private Boolean complete = false; diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Pet.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Pet.java index 4d6215faf10..9361be9283d 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Pet.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/Pet.java @@ -61,6 +61,9 @@ public static StatusEnum fromValue(String v) { } @ApiModelProperty(value = "pet status in the store") + /** + * pet status in the store + **/ private StatusEnum status = null; /** diff --git a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/User.java b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/User.java index dd95f042ad1..dd22c5bfd9f 100644 --- a/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/User.java +++ b/samples/server/petstore/jaxrs-cxf/src/gen/java/io/swagger/model/User.java @@ -28,6 +28,9 @@ public class User { @ApiModelProperty(value = "") private String phone = null; @ApiModelProperty(value = "User Status") + /** + * User Status + **/ private Integer userStatus = null; /** diff --git a/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/AnotherFakeApiServiceImpl.java b/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/AnotherFakeApiServiceImpl.java index 5de97453193..a162ec64ee7 100644 --- a/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/AnotherFakeApiServiceImpl.java +++ b/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/AnotherFakeApiServiceImpl.java @@ -16,7 +16,19 @@ import io.swagger.annotations.Api; +/** + * Swagger Petstore + * + *

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + * + */ public class AnotherFakeApiServiceImpl implements AnotherFakeApi { + /** + * To test special tags + * + * To test special tags + * + */ public Client testSpecialTags(Client body) { // TODO: Implement... diff --git a/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/FakeApiServiceImpl.java b/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/FakeApiServiceImpl.java index b170bddee2d..5e47422edf4 100644 --- a/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/FakeApiServiceImpl.java +++ b/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/FakeApiServiceImpl.java @@ -20,6 +20,12 @@ import io.swagger.annotations.Api; +/** + * Swagger Petstore + * + *

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + * + */ public class FakeApiServiceImpl implements FakeApi { public Boolean fakeOuterBooleanSerialize(Boolean body) { // TODO: Implement... @@ -45,24 +51,48 @@ public String fakeOuterStringSerialize(String body) { return null; } + /** + * To test \"client\" model + * + * To test \"client\" model + * + */ public Client testClientModel(Client body) { // TODO: Implement... return null; } + /** + * Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + * + * Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + * + */ public void testEndpointParameters(BigDecimal number, Double _double, String patternWithoutDelimiter, byte[] _byte, Integer integer, Integer int32, Long int64, Float _float, String string, byte[] binary, LocalDate date, Date dateTime, String password, String paramCallback) { // TODO: Implement... } + /** + * To test enum parameters + * + * To test enum parameters + * + */ public void testEnumParameters(List enumFormStringArray, String enumFormString, List enumHeaderStringArray, String enumHeaderString, List enumQueryStringArray, String enumQueryString, Integer enumQueryInteger, Double enumQueryDouble) { // TODO: Implement... } + /** + * test json serialization of form data + * + * + * + */ public void testJsonFormData(String param, String param2) { // TODO: Implement... diff --git a/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/FakeClassnameTags123ApiServiceImpl.java b/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/FakeClassnameTags123ApiServiceImpl.java index 539edc610d9..ad3f555af97 100644 --- a/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/FakeClassnameTags123ApiServiceImpl.java +++ b/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/FakeClassnameTags123ApiServiceImpl.java @@ -16,7 +16,17 @@ import io.swagger.annotations.Api; +/** + * Swagger Petstore + * + *

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + * + */ public class FakeClassnameTags123ApiServiceImpl implements FakeClassnameTags123Api { + /** + * To test class name in snake case + * + */ public Client testClassname(Client body) { // TODO: Implement... diff --git a/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/PetApiServiceImpl.java b/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/PetApiServiceImpl.java index d9b9345d339..439daacb1b2 100644 --- a/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/PetApiServiceImpl.java +++ b/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/PetApiServiceImpl.java @@ -18,49 +18,103 @@ import io.swagger.annotations.Api; +/** + * Swagger Petstore + * + *

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + * + */ public class PetApiServiceImpl implements PetApi { + /** + * Add a new pet to the store + * + * + * + */ public void addPet(Pet body) { // TODO: Implement... } + /** + * Deletes a pet + * + * + * + */ public void deletePet(Long petId, String apiKey) { // TODO: Implement... } + /** + * Finds Pets by status + * + * Multiple status values can be provided with comma separated strings + * + */ public List findPetsByStatus(List status) { // TODO: Implement... return null; } + /** + * Finds Pets by tags + * + * Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + * + */ public List findPetsByTags(List tags) { // TODO: Implement... return null; } + /** + * Find pet by ID + * + * Returns a single pet + * + */ public Pet getPetById(Long petId) { // TODO: Implement... return null; } + /** + * Update an existing pet + * + * + * + */ public void updatePet(Pet body) { // TODO: Implement... } + /** + * Updates a pet in the store with form data + * + * + * + */ public void updatePetWithForm(Long petId, String name, String status) { // TODO: Implement... } + /** + * uploads an image + * + * + * + */ public ModelApiResponse uploadFile(Long petId, String additionalMetadata, Attachment fileDetail) { // TODO: Implement... diff --git a/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/StoreApiServiceImpl.java b/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/StoreApiServiceImpl.java index 3f791097b6b..546d096399b 100644 --- a/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/StoreApiServiceImpl.java +++ b/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/StoreApiServiceImpl.java @@ -17,25 +17,55 @@ import io.swagger.annotations.Api; +/** + * Swagger Petstore + * + *

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + * + */ public class StoreApiServiceImpl implements StoreApi { + /** + * Delete purchase order by ID + * + * For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + * + */ public void deleteOrder(String orderId) { // TODO: Implement... } + /** + * Returns pet inventories by status + * + * Returns a map of status codes to quantities + * + */ public Map getInventory() { // TODO: Implement... return null; } + /** + * Find purchase order by ID + * + * For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + * + */ public Order getOrderById(Long orderId) { // TODO: Implement... return null; } + /** + * Place an order for a pet + * + * + * + */ public Order placeOrder(Order body) { // TODO: Implement... diff --git a/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/UserApiServiceImpl.java b/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/UserApiServiceImpl.java index 861273cfb7b..363a42dad0e 100644 --- a/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/UserApiServiceImpl.java +++ b/samples/server/petstore/jaxrs-cxf/src/main/java/io/swagger/api/impl/UserApiServiceImpl.java @@ -17,49 +17,103 @@ import io.swagger.annotations.Api; +/** + * Swagger Petstore + * + *

This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ + * + */ public class UserApiServiceImpl implements UserApi { + /** + * Create user + * + * This can only be done by the logged in user. + * + */ public void createUser(User body) { // TODO: Implement... } + /** + * Creates list of users with given input array + * + * + * + */ public void createUsersWithArrayInput(List body) { // TODO: Implement... } + /** + * Creates list of users with given input array + * + * + * + */ public void createUsersWithListInput(List body) { // TODO: Implement... } + /** + * Delete user + * + * This can only be done by the logged in user. + * + */ public void deleteUser(String username) { // TODO: Implement... } + /** + * Get user by user name + * + * + * + */ public User getUserByName(String username) { // TODO: Implement... return null; } + /** + * Logs user into the system + * + * + * + */ public String loginUser(String username, String password) { // TODO: Implement... return null; } + /** + * Logs out current logged in user session + * + * + * + */ public void logoutUser() { // TODO: Implement... } + /** + * Updated user + * + * This can only be done by the logged in user. + * + */ public void updateUser(String username, User body) { // TODO: Implement...