loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-12-21 01:57:12 +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-beanvalidation-no-nullable/src/main/java/org/openapitools/api/AnotherFakeApi.java
View File

@@ -32,6 +32,7 @@ public interface AnotherFakeApi {
return Optional.empty();
}
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
@@ -51,7 +52,7 @@ public interface AnotherFakeApi {
})
@RequestMapping(
method = RequestMethod.PATCH,
value = "/another-fake/dummy",
value = AnotherFakeApi.PATH_CALL123TEST_SPECIAL_TAGS,
produces = { "application/json" },
consumes = { "application/json" }
)

54
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/FakeApi.java
View File

@@ -44,6 +44,7 @@ public interface FakeApi {
return Optional.empty();
}
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
@@ -62,7 +63,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" }
)
@@ -74,6 +75,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
@@ -93,7 +95,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/outer/boolean",
value = FakeApi.PATH_FAKE_OUTER_BOOLEAN_SERIALIZE,
produces = { "*/*" },
consumes = { "application/json" }
)
@@ -106,6 +108,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
@@ -125,7 +128,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/outer/composite",
value = FakeApi.PATH_FAKE_OUTER_COMPOSITE_SERIALIZE,
produces = { "*/*" },
consumes = { "application/json" }
)
@@ -147,6 +150,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
@@ -166,7 +170,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/outer/number",
value = FakeApi.PATH_FAKE_OUTER_NUMBER_SERIALIZE,
produces = { "*/*" },
consumes = { "application/json" }
)
@@ -179,6 +183,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
@@ -198,7 +203,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/outer/string",
value = FakeApi.PATH_FAKE_OUTER_STRING_SERIALIZE,
produces = { "*/*" },
consumes = { "application/json" }
)
@@ -211,6 +216,7 @@ public interface FakeApi {
}
public static final String PATH_RESPONSE_OBJECT_DIFFERENT_NAMES = "/fake/{petId}/response-object-different-names";
/**
* GET /fake/{petId}/response-object-different-names
*
@@ -229,7 +235,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/fake/{petId}/response-object-different-names",
value = FakeApi.PATH_RESPONSE_OBJECT_DIFFERENT_NAMES,
produces = { "application/json" }
)
@@ -250,6 +256,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`.
@@ -268,7 +275,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" }
)
@@ -280,6 +287,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
*
@@ -298,7 +306,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" }
)
@@ -311,6 +319,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_CLIENT_MODEL = "/fake";
/**
* PATCH /fake : To test \"client\" model
* To test \"client\" model
@@ -330,7 +339,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.PATCH,
value = "/fake",
value = FakeApi.PATH_TEST_CLIENT_MODEL,
produces = { "application/json" },
consumes = { "application/json" }
)
@@ -352,6 +361,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 假端點 偽のエンドポイント 가짜 엔드 포인트
@@ -388,7 +398,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake",
value = FakeApi.PATH_TEST_ENDPOINT_PARAMETERS,
consumes = { "application/x-www-form-urlencoded" }
)
@@ -413,6 +423,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_ENUM_PARAMETERS = "/fake";
/**
* GET /fake : To test enum parameters
* To test enum parameters
@@ -440,7 +451,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/fake",
value = FakeApi.PATH_TEST_ENUM_PARAMETERS,
consumes = { "application/x-www-form-urlencoded" }
)
@@ -459,6 +470,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)
@@ -482,7 +494,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.DELETE,
value = "/fake"
value = FakeApi.PATH_TEST_GROUP_PARAMETERS
)
default ResponseEntity<Void> testGroupParameters(
@@ -498,6 +510,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_INLINE_ADDITIONAL_PROPERTIES = "/fake/inline-additionalProperties";
/**
* POST /fake/inline-additionalProperties : test inline additionalProperties
*
@@ -516,7 +529,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/inline-additionalProperties",
value = FakeApi.PATH_TEST_INLINE_ADDITIONAL_PROPERTIES,
consumes = { "application/json" }
)
@@ -528,6 +541,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_JSON_FORM_DATA = "/fake/jsonFormData";
/**
* GET /fake/jsonFormData : test json serialization of form data
*
@@ -547,7 +561,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/fake/jsonFormData",
value = FakeApi.PATH_TEST_JSON_FORM_DATA,
consumes = { "application/x-www-form-urlencoded" }
)
@@ -560,6 +574,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_NULLABLE = "/fake/nullable";
/**
* POST /fake/nullable : test nullable parent property
*
@@ -578,7 +593,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/fake/nullable",
value = FakeApi.PATH_TEST_NULLABLE,
consumes = { "application/json" }
)
@@ -590,6 +605,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
@@ -611,7 +627,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(
@@ -625,6 +641,7 @@ public interface FakeApi {
}
public static final String PATH_TEST_WITH_RESULT_EXAMPLE = "/fake/response-with-example";
/**
* GET /fake/response-with-example
* This endpoint defines an example value for its response schema.
@@ -643,7 +660,7 @@ public interface FakeApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/fake/response-with-example",
value = FakeApi.PATH_TEST_WITH_RESULT_EXAMPLE,
produces = { "application/json" }
)
@@ -664,6 +681,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)
*
@@ -691,7 +709,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-beanvalidation-no-nullable/src/main/java/org/openapitools/api/FakeClassnameTestApi.java
View File

@@ -32,6 +32,7 @@ public interface FakeClassnameTestApi {
return Optional.empty();
}
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
@@ -54,7 +55,7 @@ public interface FakeClassnameTestApi {
})
@RequestMapping(
method = RequestMethod.PATCH,
value = "/fake_classname_test",
value = FakeClassnameTestApi.PATH_TEST_CLASSNAME,
produces = { "application/json" },
consumes = { "application/json" }
)

24
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/PetApi.java
View File

@@ -34,6 +34,7 @@ public interface PetApi {
return Optional.empty();
}
public static final String PATH_ADD_PET = "/pet";
/**
* POST /pet : Add a new pet to the store
*
@@ -60,7 +61,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/pet",
value = PetApi.PATH_ADD_PET,
consumes = { "application/json", "application/xml" }
)
@@ -72,6 +73,7 @@ public interface PetApi {
}
public static final String PATH_DELETE_PET = "/pet/{petId}";
/**
* DELETE /pet/{petId} : Deletes a pet
*
@@ -99,7 +101,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.DELETE,
value = "/pet/{petId}"
value = PetApi.PATH_DELETE_PET
)
default ResponseEntity<Void> deletePet(
@@ -111,6 +113,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
@@ -139,7 +142,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/pet/findByStatus",
value = PetApi.PATH_FIND_PETS_BY_STATUS,
produces = { "application/xml", "application/json" }
)
@@ -165,6 +168,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.
@@ -195,7 +199,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/pet/findByTags",
value = PetApi.PATH_FIND_PETS_BY_TAGS,
produces = { "application/xml", "application/json" }
)
@@ -221,6 +225,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
@@ -247,7 +252,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/pet/{petId}",
value = PetApi.PATH_GET_PET_BY_ID,
produces = { "application/xml", "application/json" }
)
@@ -273,6 +278,7 @@ public interface PetApi {
}
public static final String PATH_UPDATE_PET = "/pet";
/**
* PUT /pet : Update an existing pet
*
@@ -303,7 +309,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.PUT,
value = "/pet",
value = PetApi.PATH_UPDATE_PET,
consumes = { "application/json", "application/xml" }
)
@@ -315,6 +321,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
*
@@ -341,7 +348,7 @@ public interface PetApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/pet/{petId}",
value = PetApi.PATH_UPDATE_PET_WITH_FORM,
consumes = { "application/x-www-form-urlencoded" }
)
@@ -355,6 +362,7 @@ public interface PetApi {
}
public static final String PATH_UPLOAD_FILE = "/pet/{petId}/uploadImage";
/**
* POST /pet/{petId}/uploadImage : uploads an image
*
@@ -382,7 +390,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-beanvalidation-no-nullable/src/main/java/org/openapitools/api/StoreApi.java
View File

@@ -33,6 +33,7 @@ public interface StoreApi {
return Optional.empty();
}
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
@@ -53,7 +54,7 @@ public interface StoreApi {
})
@RequestMapping(
method = RequestMethod.DELETE,
value = "/store/order/{order_id}"
value = StoreApi.PATH_DELETE_ORDER
)
default ResponseEntity<Void> deleteOrder(
@@ -64,6 +65,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
@@ -86,7 +88,7 @@ public interface StoreApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/store/inventory",
value = StoreApi.PATH_GET_INVENTORY,
produces = { "application/json" }
)
@@ -98,6 +100,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
@@ -121,7 +124,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" }
)
@@ -147,6 +150,7 @@ public interface StoreApi {
}
public static final String PATH_PLACE_ORDER = "/store/order";
/**
* POST /store/order : Place an order for a pet
*
@@ -168,7 +172,7 @@ public interface StoreApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/store/order",
value = StoreApi.PATH_PLACE_ORDER,
produces = { "application/xml", "application/json" },
consumes = { "application/json" }
)

24
samples/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/UserApi.java
View File

@@ -33,6 +33,7 @@ public interface UserApi {
return Optional.empty();
}
public static final String PATH_CREATE_USER = "/user";
/**
* POST /user : Create user
* This can only be done by the logged in user.
@@ -51,7 +52,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/user",
value = UserApi.PATH_CREATE_USER,
consumes = { "application/json" }
)
@@ -63,6 +64,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
*
@@ -81,7 +83,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/user/createWithArray",
value = UserApi.PATH_CREATE_USERS_WITH_ARRAY_INPUT,
consumes = { "application/json" }
)
@@ -93,6 +95,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
*
@@ -111,7 +114,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.POST,
value = "/user/createWithList",
value = UserApi.PATH_CREATE_USERS_WITH_LIST_INPUT,
consumes = { "application/json" }
)
@@ -123,6 +126,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.
@@ -143,7 +147,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.DELETE,
value = "/user/{username}"
value = UserApi.PATH_DELETE_USER
)
default ResponseEntity<Void> deleteUser(
@@ -154,6 +158,7 @@ public interface UserApi {
}
public static final String PATH_GET_USER_BY_NAME = "/user/{username}";
/**
* GET /user/{username} : Get user by user name
*
@@ -177,7 +182,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/user/{username}",
value = UserApi.PATH_GET_USER_BY_NAME,
produces = { "application/xml", "application/json" }
)
@@ -203,6 +208,7 @@ public interface UserApi {
}
public static final String PATH_LOGIN_USER = "/user/login";
/**
* GET /user/login : Logs user into the system
*
@@ -225,7 +231,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/user/login",
value = UserApi.PATH_LOGIN_USER,
produces = { "application/xml", "application/json" }
)
@@ -238,6 +244,7 @@ public interface UserApi {
}
public static final String PATH_LOGOUT_USER = "/user/logout";
/**
* GET /user/logout : Logs out current logged in user session
*
@@ -255,7 +262,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.GET,
value = "/user/logout"
value = UserApi.PATH_LOGOUT_USER
)
default ResponseEntity<Void> logoutUser(
@@ -266,6 +273,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.
@@ -287,7 +295,7 @@ public interface UserApi {
})
@RequestMapping(
method = RequestMethod.PUT,
value = "/user/{username}",
value = UserApi.PATH_UPDATE_USER,
consumes = { "application/json" }
)