loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-21 03:17:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

1385 Generate constants for path in spring boot @RequestMapping (#19782)

Browse Source
This commit is contained in:
Lukáš Vasek
2025-07-09 10:26:52 +02:00
committed by GitHub
parent 1b352c2d00
commit 117be2ca4c
194 changed files with 2377 additions and 1189 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/AnotherFakeApi.java
View File

@@ -28,6 +28,7 @@ public interface AnotherFakeApi {
return new AnotherFakeApiDelegate() {};
}
public static final String PATH_CALL123TEST_SPECIAL_TAGS = "/another-fake/dummy";
/**
* PATCH /another-fake/dummy : To test special tags
* To test special tags and operation ID starting with number
@@ -47,7 +48,7 @@ public interface AnotherFakeApi {
})
@RequestMapping(
method = RequestMethod.PATCH,
value = "/another-fake/dummy",
value = AnotherFakeApi.PATH_CALL123TEST_SPECIAL_TAGS,
produces = { "application/json" },
consumes = { "application/json" }
)

45
samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/FakeApi.java
View File

@@ -38,6 +38,7 @@ public interface FakeApi {
return new FakeApiDelegate() {};
}
public static final String PATH_CREATE_XML_ITEM = "/fake/create_xml_item";
/**
* POST /fake/create_xml_item : creates an XmlItem
* this route creates an XmlItem
@@ -56,7 +57,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/create_xml_item",
value = FakeApi.PATH_CREATE_XML_ITEM,
consumes = { "application/xml", "application/xml; charset=utf-8", "application/xml; charset=utf-16", "text/xml", "text/xml; charset=utf-8", "text/xml; charset=utf-16" }
)
@@ -67,6 +68,7 @@ public interface FakeApi {
}
public static final String PATH_FAKE_OUTER_BOOLEAN_SERIALIZE = "/fake/outer/boolean";
/**
* POST /fake/outer/boolean
* Test serialization of outer boolean types
@@ -86,7 +88,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/outer/boolean",
value = FakeApi.PATH_FAKE_OUTER_BOOLEAN_SERIALIZE,
produces = { "*/*" }
)
@@ -97,6 +99,7 @@ public interface FakeApi {
}
public static final String PATH_FAKE_OUTER_COMPOSITE_SERIALIZE = "/fake/outer/composite";
/**
* POST /fake/outer/composite
* Test serialization of object with outer number type
@@ -116,7 +119,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/outer/composite",
value = FakeApi.PATH_FAKE_OUTER_COMPOSITE_SERIALIZE,
produces = { "*/*" }
)
@@ -127,6 +130,7 @@ public interface FakeApi {
}
public static final String PATH_FAKE_OUTER_NUMBER_SERIALIZE = "/fake/outer/number";
/**
* POST /fake/outer/number
* Test serialization of outer number types
@@ -146,7 +150,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/outer/number",
value = FakeApi.PATH_FAKE_OUTER_NUMBER_SERIALIZE,
produces = { "*/*" }
)
@@ -157,6 +161,7 @@ public interface FakeApi {
}
public static final String PATH_FAKE_OUTER_STRING_SERIALIZE = "/fake/outer/string";
/**
* POST /fake/outer/string
* Test serialization of outer string types
@@ -176,7 +181,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/outer/string",
value = FakeApi.PATH_FAKE_OUTER_STRING_SERIALIZE,
produces = { "*/*" }
)
@@ -187,6 +192,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_BODY_WITH_FILE_SCHEMA = "/fake/body-with-file-schema";
/**
* PUT /fake/body-with-file-schema
* For this test, the body for this request much reference a schema named `File`.
@@ -205,7 +211,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.PUT,
value = "/fake/body-with-file-schema",
value = FakeApi.PATH_TEST_BODY_WITH_FILE_SCHEMA,
consumes = { "application/json" }
)
@@ -216,6 +222,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_BODY_WITH_QUERY_PARAMS = "/fake/body-with-query-params";
/**
* PUT /fake/body-with-query-params
*
@@ -234,7 +241,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.PUT,
value = "/fake/body-with-query-params",
value = FakeApi.PATH_TEST_BODY_WITH_QUERY_PARAMS,
consumes = { "application/json" }
)
@@ -246,6 +253,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_CLIENT_MODEL = "/fake";
/**
* PATCH /fake : To test \"client\" model
* To test \"client\" model
@@ -265,7 +273,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.PATCH,
value = "/fake",
value = FakeApi.PATH_TEST_CLIENT_MODEL,
produces = { "application/json" },
consumes = { "application/json" }
)
@@ -277,6 +285,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_ENDPOINT_PARAMETERS = "/fake";
/**
* POST /fake : Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
* Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
@@ -313,7 +322,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake",
value = FakeApi.PATH_TEST_ENDPOINT_PARAMETERS,
consumes = { "application/x-www-form-urlencoded" }
)
@@ -337,6 +346,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_ENUM_PARAMETERS = "/fake";
/**
* GET /fake : To test enum parameters
* To test enum parameters
@@ -364,7 +374,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/fake",
value = FakeApi.PATH_TEST_ENUM_PARAMETERS,
consumes = { "application/x-www-form-urlencoded" }
)
@@ -382,6 +392,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_GROUP_PARAMETERS = "/fake";
/**
* DELETE /fake : Fake endpoint to test group parameters (optional)
* Fake endpoint to test group parameters (optional)
@@ -405,7 +416,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.DELETE,
value = "/fake"
value = FakeApi.PATH_TEST_GROUP_PARAMETERS
)
default ResponseEntity<Void> testGroupParameters(
@@ -420,6 +431,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties";
/**
* POST /fake/inline-additionalProperties : test inline additionalProperties
*
@@ -437,7 +449,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/inline-additionalProperties",
value = FakeApi.PATH_TEST_INLINE_ADDITIONAL_PROPERTIES,
consumes = { "application/json" }
)
@@ -448,6 +460,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData";
/**
* GET /fake/jsonFormData : test json serialization of form data
*
@@ -466,7 +479,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/fake/jsonFormData",
value = FakeApi.PATH_TEST_JSON_FORM_DATA,
consumes = { "application/x-www-form-urlencoded" }
)
@@ -478,6 +491,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT = "/fake/test-query-parameters";
/**
* PUT /fake/test-query-parameters
* To test the collection format in query parameters
@@ -500,7 +514,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.PUT,
value = "/fake/test-query-parameters"
value = FakeApi.PATH_TEST_QUERY_PARAMETER_COLLECTION_FORMAT
)
default ResponseEntity<Void> testQueryParameterCollectionFormat(
@@ -514,6 +528,7 @@ public interface FakeApi {
}
public static final String PATH_UPLOAD_FILE_WITH_REQUIRED_FILE = "/fake/{petId}/uploadImageWithRequiredFile";
/**
* POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required)
*
@@ -540,7 +555,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/{petId}/uploadImageWithRequiredFile",
value = FakeApi.PATH_UPLOAD_FILE_WITH_REQUIRED_FILE,
produces = { "application/json" },
consumes = { "multipart/form-data" }
)

3
samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/FakeClassnameTestApi.java
View File

@@ -28,6 +28,7 @@ public interface FakeClassnameTestApi {
return new FakeClassnameTestApiDelegate() {};
}
public static final String PATH_TEST_CLASSNAME = "/fake_classname_test";
/**
* PATCH /fake_classname_test : To test class name in snake case
* To test class name in snake case
@@ -50,7 +51,7 @@ public interface FakeClassnameTestApi {
})
@RequestMapping(
method = RequestMethod.PATCH,
value = "/fake_classname_test",
value = FakeClassnameTestApi.PATH_TEST_CLASSNAME,
produces = { "application/json" },
consumes = { "application/json" }
)

27
samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/PetApi.java
View File

@@ -31,6 +31,7 @@ public interface PetApi {
return new PetApiDelegate() {};
}
public static final String PATH_ADD_PET = "/pet";
/**
* POST /pet : Add a new pet to the store
*
@@ -56,7 +57,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/pet",
value = PetApi.PATH_ADD_PET,
consumes = { "application/json", "application/xml" }
)
@@ -67,6 +68,7 @@ public interface PetApi {
}
public static final String PATH_DELETE_PET = "/pet/{petId}";
/**
* DELETE /pet/{petId} : Deletes a pet
*
@@ -93,7 +95,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.DELETE,
value = "/pet/{petId}"
value = PetApi.PATH_DELETE_PET
)
default ResponseEntity<Void> deletePet(
@@ -104,6 +106,7 @@ public interface PetApi {
}
public static final String PATH_FIND_PETS_BY_STATUS = "/pet/findByStatus";
/**
* GET /pet/findByStatus : Finds Pets by status
* Multiple status values can be provided with comma separated strings
@@ -132,7 +135,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/pet/findByStatus",
value = PetApi.PATH_FIND_PETS_BY_STATUS,
produces = { "application/xml", "application/json" }
)
@@ -144,6 +147,7 @@ public interface PetApi {
}
public static final String PATH_FIND_PETS_BY_TAGS = "/pet/findByTags";
/**
* GET /pet/findByTags : Finds Pets by tags
* Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
@@ -175,7 +179,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/pet/findByTags",
value = PetApi.PATH_FIND_PETS_BY_TAGS,
produces = { "application/xml", "application/json" }
)
@@ -188,6 +192,7 @@ public interface PetApi {
}
public static final String PATH_GET_PET_BY_ID = "/pet/{petId}";
/**
* GET /pet/{petId} : Find pet by ID
* Returns a single pet
@@ -214,7 +219,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/pet/{petId}",
value = PetApi.PATH_GET_PET_BY_ID,
produces = { "application/xml", "application/json" }
)
@@ -225,6 +230,7 @@ public interface PetApi {
}
public static final String PATH_LIST_ALL_PETS = "/pet/all";
/**
* GET /pet/all : List all pets
*
@@ -251,7 +257,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/pet/all",
value = PetApi.PATH_LIST_ALL_PETS,
produces = { "application/xml", "application/json" }
)
@@ -262,6 +268,7 @@ public interface PetApi {
}
public static final String PATH_UPDATE_PET = "/pet";
/**
* PUT /pet : Update an existing pet
*
@@ -291,7 +298,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.PUT,
value = "/pet",
value = PetApi.PATH_UPDATE_PET,
consumes = { "application/json", "application/xml" }
)
@@ -302,6 +309,7 @@ public interface PetApi {
}
public static final String PATH_UPDATE_PET_WITH_FORM = "/pet/{petId}";
/**
* POST /pet/{petId} : Updates a pet in the store with form data
*
@@ -327,7 +335,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/pet/{petId}",
value = PetApi.PATH_UPDATE_PET_WITH_FORM,
consumes = { "application/x-www-form-urlencoded" }
)
@@ -340,6 +348,7 @@ public interface PetApi {
}
public static final String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage";
/**
* POST /pet/{petId}/uploadImage : uploads an image
*
@@ -366,7 +375,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/pet/{petId}/uploadImage",
value = PetApi.PATH_UPLOAD_FILE,
produces = { "application/json" },
consumes = { "multipart/form-data" }
)

12
samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/StoreApi.java
View File

@@ -29,6 +29,7 @@ public interface StoreApi {
return new StoreApiDelegate() {};
}
public static final String PATH_DELETE_ORDER = "/store/order/{order_id}";
/**
* DELETE /store/order/{order_id} : Delete purchase order by ID
* For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
@@ -49,7 +50,7 @@ public interface StoreApi {
})
@RequestMapping(
method = RequestMethod.DELETE,
value = "/store/order/{order_id}"
value = StoreApi.PATH_DELETE_ORDER
)
default ResponseEntity<Void> deleteOrder(
@@ -59,6 +60,7 @@ public interface StoreApi {
}
public static final String PATH_GET_INVENTORY = "/store/inventory";
/**
* GET /store/inventory : Returns pet inventories by status
* Returns a map of status codes to quantities
@@ -81,7 +83,7 @@ public interface StoreApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/store/inventory",
value = StoreApi.PATH_GET_INVENTORY,
produces = { "application/json" }
)
@@ -92,6 +94,7 @@ public interface StoreApi {
}
public static final String PATH_GET_ORDER_BY_ID = "/store/order/{order_id}";
/**
* GET /store/order/{order_id} : Find purchase order by ID
* For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generate exceptions
@@ -115,7 +118,7 @@ public interface StoreApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/store/order/{order_id}",
value = StoreApi.PATH_GET_ORDER_BY_ID,
produces = { "application/xml", "application/json" }
)
@@ -126,6 +129,7 @@ public interface StoreApi {
}
public static final String PATH_PLACE_ORDER = "/store/order";
/**
* POST /store/order : Place an order for a pet
*
@@ -146,7 +150,7 @@ public interface StoreApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/store/order",
value = StoreApi.PATH_PLACE_ORDER,
produces = { "application/xml", "application/json" }
)

24
samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/UserApi.java
View File

@@ -29,6 +29,7 @@ public interface UserApi {
return new UserApiDelegate() {};
}
public static final String PATH_CREATE_USER = "/user";
/**
* POST /user : Create user
* This can only be done by the logged in user.
@@ -47,7 +48,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/user"
value = UserApi.PATH_CREATE_USER
)
default ResponseEntity<Void> createUser(
@@ -57,6 +58,7 @@ public interface UserApi {
}
public static final String PATH_CREATE_USERS_WITH_ARRAY_INPUT = "/user/createWithArray";
/**
* POST /user/createWithArray : Creates list of users with given input array
*
@@ -74,7 +76,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/user/createWithArray"
value = UserApi.PATH_CREATE_USERS_WITH_ARRAY_INPUT
)
default ResponseEntity<Void> createUsersWithArrayInput(
@@ -84,6 +86,7 @@ public interface UserApi {
}
public static final String PATH_CREATE_USERS_WITH_LIST_INPUT = "/user/createWithList";
/**
* POST /user/createWithList : Creates list of users with given input array
*
@@ -101,7 +104,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/user/createWithList"
value = UserApi.PATH_CREATE_USERS_WITH_LIST_INPUT
)
default ResponseEntity<Void> createUsersWithListInput(
@@ -111,6 +114,7 @@ public interface UserApi {
}
public static final String PATH_DELETE_USER = "/user/{username}";
/**
* DELETE /user/{username} : Delete user
* This can only be done by the logged in user.
@@ -131,7 +135,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.DELETE,
value = "/user/{username}"
value = UserApi.PATH_DELETE_USER
)
default ResponseEntity<Void> deleteUser(
@@ -141,6 +145,7 @@ public interface UserApi {
}
public static final String PATH_GET_USER_BY_NAME = "/user/{username}";
/**
* GET /user/{username} : Get user by user name
*
@@ -163,7 +168,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/user/{username}",
value = UserApi.PATH_GET_USER_BY_NAME,
produces = { "application/xml", "application/json" }
)
@@ -174,6 +179,7 @@ public interface UserApi {
}
public static final String PATH_LOGIN_USER = "/user/login";
/**
* GET /user/login : Logs user into the system
*
@@ -195,7 +201,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/user/login",
value = UserApi.PATH_LOGIN_USER,
produces = { "application/xml", "application/json" }
)
@@ -207,6 +213,7 @@ public interface UserApi {
}
public static final String PATH_LOGOUT_USER = "/user/logout";
/**
* GET /user/logout : Logs out current logged in user session
*
@@ -223,7 +230,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/user/logout"
value = UserApi.PATH_LOGOUT_USER
)
default ResponseEntity<Void> logoutUser(
@@ -233,6 +240,7 @@ public interface UserApi {
}
public static final String PATH_UPDATE_USER = "/user/{username}";
/**
* PUT /user/{username} : Updated user
* This can only be done by the logged in user.
@@ -254,7 +262,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.PUT,
value = "/user/{username}"
value = UserApi.PATH_UPDATE_USER
)
default ResponseEntity<Void> updateUser(

9
samples/server/petstore/springboot-spring-pageable-delegatePattern-without-j8/src/main/java/org/openapitools/api/VersioningApi.java
View File

@@ -28,6 +28,7 @@ public interface VersioningApi {
return new VersioningApiDelegate() {};
}
public static final String PATH_VERSIONING_HEADERS = "/versioning/headers";
/**
* POST /versioning/headers
*
@@ -48,7 +49,7 @@ public interface VersioningApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/versioning/headers",
value = VersioningApi.PATH_VERSIONING_HEADERS,
produces = { "*/*" },
headers = { "VersionWithDefaultValue=V1", "VersionNoDefaultValue" }
)
@@ -62,6 +63,7 @@ public interface VersioningApi {
}
public static final String PATH_VERSIONING_MIX = "/versioning/mix";
/**
* POST /versioning/mix
*
@@ -84,7 +86,7 @@ public interface VersioningApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/versioning/mix",
value = VersioningApi.PATH_VERSIONING_MIX,
produces = { "*/*" },
headers = { "VersionWithDefaultValueHeader=V1", "VersionNoDefaultValueHeader" } ,
params = { "VersionWithDefaultValueQuery=V1", "VersionNoDefaultValueQuery" }
@@ -101,6 +103,7 @@ public interface VersioningApi {
}
public static final String PATH_VERSIONING_QUERY_PARAMS = "/versioning/query-params";
/**
* POST /versioning/query-params
*
@@ -121,7 +124,7 @@ public interface VersioningApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/versioning/query-params",
value = VersioningApi.PATH_VERSIONING_QUERY_PARAMS,
produces = { "*/*" },
params = { "VersionWithDefaultValue=V1", "VersionNoDefaultValue" }
)