Fügen Sie eine header-parameter in Swagger-UI-Dokumentation mit Springfox

Möchte ich hinzufügen, dass ein header-Feld parameter in der automatisch generierten swagger ui Dokumentation meiner rest-Dienst. Ich benutze Frühjahr und Springfox.

public ResponseEntity<User> saveNewUser(
        @ApiParam(value = "the user to create", required = true) @RequestBody User user) throws RestServiceException {

    userService.save(user);
    return new ResponseEntity<User>(user, HttpStatus.OK);
}

Wie Sie sehen, habe ich bereits eine Körper Typ-parameter. Ich möchte nur hinzufügen, eine header geben.

InformationsquelleAutor Julien | 2016-11-25

Bevorzuge ich @ApiImplicitParam nach meinem @RequestMapping nicht als Parameter der Funktion, denn in der Regel könnten Sie verarbeiten Ihre Header in einem filter (z.B. Authentifizierung), und Sie werden nicht benötigen, die Werte, die in dieser Methode.

Neben, wenn Sie Sie brauchen in der Methode Swagger auto bietet das Feld für eine @HeaderParam

Dieser Stil auch die Lesbarkeit Verbessert und die Flexibilität, wenn einige Anrufe müssen Kopf-und andere nicht.

Beispiel

@PostMapping
@ApiImplicitParam(name = "Authorization", value = "Access Token", required = true, allowEmptyValue = false, paramType = "header", dataTypeClass = String::class, example = "Bearer access_token")
fun addJob(jobRequest: Job): ResponseEntity<*>{}

Wenn alle oder die meisten für Ihre Endgeräte brauchen, header, ich werde eher eine Konfiguration als gesehen hier

Wenn Sie erklären müssen, mehrere header params, müssen Sie die @ApiImplicitParams Anmerkung:

@PostMapping
@ApiImplicitParams(
  @ApiImplicitParam(name = "Authorization", value = "Access Token", required = true, allowEmptyValue = false, paramType = "header", dataTypeClass = String::class, example = "Bearer access_token"),
  @ApiImplicitParam(name = "X-Custom-Header", value = "A Custom Header", required = true, allowEmptyValue = false, paramType = "header", dataTypeClass = String::class, example = "my header example")
)
fun addJob(jobRequest: Job): ResponseEntity<*>{}

InformationsquelleAutor Enoobong

Habe ich nur noch @RequestHeader(value="myHeader") String headerStr :

public ResponseEntity<User> saveNewUser(
        @RequestHeader(value="myHeader") String headerStr,
        @ApiParam(value = "the user to create", required = true) @RequestBody User user) throws RestServiceException {

    userService.save(user);
    return new ResponseEntity<User>(user, HttpStatus.OK);
}

(import org.springframework.web.bind.annotation.RequestHeader;)

Können Sie auch fügen Sie eine Globale Kopfzeile auf jeder service in Ihrer Dokumentation mit der Lösung hier beschrieben : Frühling + Springfox + Header-Parameter

InformationsquelleAutor Julien

Wenn du mehr header-Parameter, dann wird jeder API haben, dass viele @RequestHeader

Um dies zu vermeiden und Ihrem API-sieht einfach aus, die Sie verwenden können HeaderInterceptor zu erfassen, die header-Informationen.

In preHandle() ,  you need to extract the headerInfo in to a an Object and set it as RequestAttribute

  public class MyHeaderInterceptor extends HandlerInterceptorAdapter {

  @Override
  public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
        throws Exception { 

    HeaderVo headerVo = HeaderVo.createReqHeaderinput(
            request.getHeader("authorization"),
            request.getHeader("contentType"),                
            request.getHeader("myHeaderParam0"),
            request.getHeader("myHeaderParam1"), 
            request.getHeader("myHeaderParam3"),
            request.getHeader("myHeaderParam4"),
            request.getHeader("myHeaderParam5")

            );

     //You can do any validation of any headerInfo here.
     validateHeader(headerVo);

     request.setAttribute("headerName", headerVo);
     return true;
   }

 }

Ihre API aussieht, wie die unten mit einer @RequestAttribute("headerName")

public @ResponseBody
ResponseEntity<MyResponse> getSomeApi(
        //Headers common for all the API's       

        @RequestAttribute("headerName") HeaderVo header ,
        @ApiParam(value = "otherAPiParam", required = true, defaultValue = "") 
        @PathVariable(value = "otherAPiParam") String otherAPiParam,
        @ApiParam(value = "otherAPiParam1", required = true, defaultValue = "") 
        @RequestParam(value = "otherAPiParam1") String otherAPiParam1,
        @ApiParam(value = "otherAPiParam2, required = true, defaultValue = "")
        @RequestParam(value = "otherAPiParam2") String otherAPiParam2
     ) throws MyExcp  {
  ....
 }

Ihre Swagger sollte dennoch beschreibt alle Header der API können Sie Parameter hinzufügen, in Fors Laufzettel, SwaggerConfig
Bitte beachten Sie ignoredParameterTypes, haben wir bereits erwähnt, zu ignorieren HeaderVo, weil die innerhalb der Anwendung. Arroganz hat nicht verlangen, um zu zeigen, dass

@Bean
public Docket postsApi() {

    //Adding Header
    ParameterBuilder aParameterBuilder = new ParameterBuilder();
    List<Parameter> aParameters = new ArrayList<Parameter>();

    aParameters.clear();

    aParameterBuilder.name("myHeaderParam0").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
    aParameters.add(aParameterBuilder.build());
    aParameterBuilder.name("myHeaderParam1").modelRef(new ModelRef("string")).parameterType("header").required(false).build();
    aParameters.add(aParameterBuilder.build());
   ....
   ....

    return new Docket(DocumentationType.SWAGGER_2).groupName("public-api")
            .apiInfo(apiInfo()).select().paths(postPaths()).build().ignoredParameterTypes(HeaderVo.class).globalOperationParameters(aParameters);

   }

InformationsquelleAutor sujith kasthoori

Schreibe einen Kommentar

Du musst angemeldet sein, um einen Kommentar abzugeben.