Skip to content

Do not apply content-type header if no request body #6648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wing328 merged 7 commits into from
Nov 27, 2017
Merged

Do not apply content-type header if no request body #6648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
afac77f
Do not apply content-type header if no request body
bmordue Oct 9, 2017
1d67377
Set content-type header if there are form params
bmordue Oct 16, 2017
ac79987
Add tests
bmordue Oct 16, 2017
af3c5f8
Run update script
bmordue Oct 16, 2017
a5d651d
Merge branch 'master' of https://github.com/swagger-api/swagger-codeg…
bmordue Oct 16, 2017
bd54d6e
Regenerated sample clients
bmordue Oct 16, 2017
fa9d385
Merge branch 'master' into fix-6647
wing328 Nov 27, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/AbstractJavaCodegen.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
import io.swagger.models.Operation;
import io.swagger.models.Path;
import io.swagger.models.Swagger;
import io.swagger.models.parameters.BodyParameter;
import io.swagger.models.parameters.FormParameter;
import io.swagger.models.parameters.Parameter;
import io.swagger.models.properties.ArrayProperty;
Expand Down Expand Up @@ -941,13 +942,16 @@ public void preprocessSwagger(Swagger swagger) {
}
for (Operation operation : path.getOperations()) {
boolean hasFormParameters = false;
boolean hasBodyParameters = false;
for (Parameter parameter : operation.getParameters()) {
if (parameter instanceof FormParameter) {
hasFormParameters = true;
}
if (parameter instanceof BodyParameter) {
hasBodyParameters = true;
}
}
//only add content-Type if its no a GET-Method
if(path.getGet() != null || ! operation.equals(path.getGet())){
if (hasBodyParameters || hasFormParameters){
String defaultContentType = hasFormParameters ? "application/x-www-form-urlencoded" : "application/json";
String contentType = operation.getConsumes() == null || operation.getConsumes().isEmpty() ? defaultContentType : operation.getConsumes().get(0);
operation.setVendorExtension("x-contentType", contentType);
Expand Down
8 changes: 4 additions & 4 deletions modules/swagger-codegen/src/main/resources/Java/libraries/feign/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ public interface {{classname}} extends ApiClient.Api {
*/
@RequestLine("{{httpMethod}} {{{path}}}{{#hasQueryParams}}?{{/hasQueryParams}}{{#queryParams}}{{baseName}}={{=<% %>=}}{<%paramName%>}<%={{ }}=%>{{#hasMore}}&{{/hasMore}}{{/queryParams}}")
@Headers({
"Content-Type: {{vendorExtensions.x-contentType}}",
"Accept: {{vendorExtensions.x-accepts}}",{{#headerParams}}
{{#vendorExtensions.x-contentType}} "Content-Type: {{vendorExtensions.x-contentType}}",
{{/vendorExtensions.x-contentType}} "Accept: {{vendorExtensions.x-accepts}}",{{#headerParams}}
"{{baseName}}: {{=<% %>=}}{<%paramName%>}<%={{ }}=%>"{{#hasMore}},
{{/hasMore}}{{/headerParams}}
})
Expand Down Expand Up @@ -75,8 +75,8 @@ public interface {{classname}} extends ApiClient.Api {
*/
@RequestLine("{{httpMethod}} {{{path}}}?{{#queryParams}}{{baseName}}={{=<% %>=}}{<%paramName%>}<%={{ }}=%>{{#hasMore}}&{{/hasMore}}{{/queryParams}}")
@Headers({
"Content-Type: {{vendorExtensions.x-contentType}}",
"Accept: {{vendorExtensions.x-accepts}}",{{#headerParams}}
{{#vendorExtensions.x-contentType}} "Content-Type: {{vendorExtensions.x-contentType}}",
{{/vendorExtensions.x-contentType}} "Accept: {{vendorExtensions.x-accepts}}",{{#headerParams}}
"{{baseName}}: {{=<% %>=}}{<%paramName%>}<%={{ }}=%>"{{#hasMore}},
{{/hasMore}}{{/headerParams}}
})
Expand Down
48 changes: 48 additions & 0 deletions modules/swagger-codegen/src/test/java/io/swagger/codegen/java/AbstractJavaCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

import io.swagger.codegen.CodegenType;
import io.swagger.codegen.languages.AbstractJavaCodegen;
import io.swagger.models.*;
import io.swagger.models.parameters.*;

public class AbstractJavaCodegenTest {

Expand Down Expand Up @@ -49,4 +51,50 @@ public void toModelNameShouldUseProvidedMapping() throws Exception {
public void toModelNameUsesPascalCase() throws Exception {
Assert.assertEquals("JsonAnotherclass", fakeJavaCodegen.toModelName("json_anotherclass"));
}

@Test
public void preprocessSwaggerWithFormParamsSetsContentType() {
Path dummyPath = new Path()
.post(new Operation().parameter(new FormParameter()))
.get(new Operation());

Swagger swagger = new Swagger()
.path("dummy", dummyPath);

fakeJavaCodegen.preprocessSwagger(swagger);

Assert.assertNull(swagger.getPath("dummy").getGet().getVendorExtensions().get("x-contentType"));
Assert.assertEquals(swagger.getPath("dummy").getPost().getVendorExtensions().get("x-contentType"), "application/x-www-form-urlencoded");
}

@Test
public void preprocessSwaggerWithBodyParamsSetsContentType() {
Path dummyPath = new Path()
.post(new Operation().parameter(new BodyParameter()))
.get(new Operation());

Swagger swagger = new Swagger()
.path("dummy", dummyPath);

fakeJavaCodegen.preprocessSwagger(swagger);

Assert.assertNull(swagger.getPath("dummy").getGet().getVendorExtensions().get("x-contentType"));
Assert.assertEquals(swagger.getPath("dummy").getPost().getVendorExtensions().get("x-contentType"), "application/json");
}

@Test
public void preprocessSwaggerWithNoFormOrBodyParamsDoesNotSetContentType() {
Path dummyPath = new Path()
.post(new Operation())
.get(new Operation());

Swagger swagger = new Swagger()
.path("dummy", dummyPath);

fakeJavaCodegen.preprocessSwagger(swagger);

Assert.assertNull(swagger.getPath("dummy").getGet().getVendorExtensions().get("x-contentType"));
Assert.assertNull(swagger.getPath("dummy").getPost().getVendorExtensions().get("x-contentType"));
}

}
6 changes: 0 additions & 6 deletions samples/client/petstore/java/feign/src/main/java/io/swagger/client/api/PetApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ public interface PetApi extends ApiClient.Api {
*/
@RequestLine("DELETE /pet/{petId}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
"api_key: {apiKey}"
})
Expand All @@ -51,7 +50,6 @@ public interface PetApi extends ApiClient.Api {
*/
@RequestLine("GET /pet/findByStatus?status={status}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
List<Pet> findPetsByStatus(@Param("status") List<String> status);
Expand All @@ -73,7 +71,6 @@ public interface PetApi extends ApiClient.Api {
*/
@RequestLine("GET /pet/findByStatus?status={status}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
List<Pet> findPetsByStatus(@QueryMap(encoded=true) Map<String, Object> queryParams);
Expand All @@ -97,7 +94,6 @@ public FindPetsByStatusQueryParams status(final List<String> value) {
*/
@RequestLine("GET /pet/findByTags?tags={tags}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
List<Pet> findPetsByTags(@Param("tags") List<String> tags);
Expand All @@ -119,7 +115,6 @@ public FindPetsByStatusQueryParams status(final List<String> value) {
*/
@RequestLine("GET /pet/findByTags?tags={tags}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
List<Pet> findPetsByTags(@QueryMap(encoded=true) Map<String, Object> queryParams);
Expand All @@ -143,7 +138,6 @@ public FindPetsByTagsQueryParams tags(final List<String> value) {
*/
@RequestLine("GET /pet/{petId}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Pet getPetById(@Param("petId") Long petId);
Expand Down
3 changes: 0 additions & 3 deletions samples/client/petstore/java/feign/src/main/java/io/swagger/client/api/StoreApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ public interface StoreApi extends ApiClient.Api {
*/
@RequestLine("DELETE /store/order/{orderId}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void deleteOrder(@Param("orderId") String orderId);
Expand All @@ -34,7 +33,6 @@ public interface StoreApi extends ApiClient.Api {
*/
@RequestLine("GET /store/inventory")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Map<String, Integer> getInventory();
Expand All @@ -47,7 +45,6 @@ public interface StoreApi extends ApiClient.Api {
*/
@RequestLine("GET /store/order/{orderId}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
Order getOrderById(@Param("orderId") Long orderId);
Expand Down
5 changes: 0 additions & 5 deletions samples/client/petstore/java/feign/src/main/java/io/swagger/client/api/UserApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,6 @@ public interface UserApi extends ApiClient.Api {
*/
@RequestLine("DELETE /user/{username}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void deleteUser(@Param("username") String username);
Expand All @@ -71,7 +70,6 @@ public interface UserApi extends ApiClient.Api {
*/
@RequestLine("GET /user/{username}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
User getUserByName(@Param("username") String username);
Expand All @@ -85,7 +83,6 @@ public interface UserApi extends ApiClient.Api {
*/
@RequestLine("GET /user/login?username={username}&password={password}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
String loginUser(@Param("username") String username, @Param("password") String password);
Expand All @@ -108,7 +105,6 @@ public interface UserApi extends ApiClient.Api {
*/
@RequestLine("GET /user/login?username={username}&password={password}")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
String loginUser(@QueryMap(encoded=true) Map<String, Object> queryParams);
Expand All @@ -134,7 +130,6 @@ public LoginUserQueryParams password(final String value) {
*/
@RequestLine("GET /user/logout")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
void logoutUser();
Expand Down
1 change: 0 additions & 1 deletion samples/client/petstore/java/retrofit2rx/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,6 @@
</dependency>



<!-- test dependencies -->
<dependency>
<groupId>junit</groupId>
Expand Down
1 change: 0 additions & 1 deletion samples/client/petstore/java/retrofit2rx2/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -235,7 +235,6 @@
</dependency>



<!-- test dependencies -->
<dependency>
<groupId>junit</groupId>
Expand Down