Comment envoyer l'en-tête d'autorisation avec une requête dans l'interface utilisateur Swagger?

J'ai un ASP.NET Web Api 2 de la demande. J'ai ajouté Swashbuckle (Swagger .NET). Il affiche mes points de terminaison pas de problème, mais dans le but d'envoyer une demande que j'ai besoin de joindre un en-tête d'Autorisation à cette demande. Si je comprends bien, pour ce faire j'ai besoin de modifier le index.html fichier (https://github.com/swagger-api/swagger-ui#how-to-use-it) donc je git cloné Swashbuckle projet afin de le modifier index.html et ajouter des en-têtes.

Est que le seul moyen d'envoyer des en-tête d'Autorisation à la demande de Swashbuckle?

source d'informationauteur Marta

11

Afin d'envoyer l'en-tête d'Autorisation avec une demande à l'aide Swagger UI j'avais besoin de:
1. Donné le nom de mon assemblée: Mon.De l'assemblée et il contient un dossier: Swagger,
  où j'ai placé mes personnalisé index.html, j'ai ajouté cette ligne dans SwaggerConfig.cs:
```
 c.CustomAsset("index", thisAssembly, "My.Assembly.Swagger.index.html");
```
Noter que index.html charge les fichiers javascript et css. J'ai dû changer tous les points de pointillés dans les chemins de fichier pour les fichiers à charger. Je ne sais pas pourquoi il a dû être fait, mais il a résolu le problème de chargement du fichier...
1. Dans le index.html fichier que j'ai modifié le
  
  addApiKeyAuthorization()
fonction ressembler à ça:
```
function addApiKeyAuthorization() {
        var key = encodeURIComponent($('#input_apiKey')[0].value);
        if (key && key.trim() != "") {
            var value = "auth-scheme api_key=123456,order_id=56789";
            var authKeyHeader = new SwaggerClient.ApiKeyAuthorization("Authorization", value, "header");
            window.swaggerUi.api.clientAuthorizations.add("Authorization", authKeyHeader);
        }
    }
```
Noter que j'ai changé de "requête" à "en-tête".
1. J'ai aussi retiré ce code:
```
var apiKey = "this field represents header but can be anything as long as its not empty";
$('#input_apiKey').val(apiKey);
```
qui permet d'afficher du texte dans la deuxième zone de texte, mais il semble qu'il n'a pas d'importance ce qu'il contient, tant qu'il n'est pas vide.

Qui a fonctionné pour moi et m'a permis de charger des index.html fichier. Maintenant, je suis à la recherche à permettre à Swagger de l'INTERFACE utilisateur de l'utilisateur de manipuler la valeur des paramètres d'en-tête...

J'ai ajouté le code ci-dessous dans un fichier js et de l'ajouter en tant que ressource incorporée à mon projet d'api web. Lorsque vous générez et exécutez Swagger, api_key zone de texte sera remplacé par la Clé d'Autorisation Zone de Texte où vous pouvez coller votre AuthKey et avec chaque demande, swagger va ajouter à en-tête de Requête.

(function () {

    $(function () {
        var basicAuthUI =
         '<div class="input"><input placeholder="Authorization Token" id="input_token" name="token" type="text"></div>';
            $(basicAuthUI).insertBefore('#api_selector div.input:last-child');
            $("#input_apiKey").hide();
            $('#input_token').change(addAuthorization);
    });

    function addAuthorization() {
        var token = $('#input_token').val();

        if (token && token.trim() !== "" ) {
            window.swaggerUi.api.clientAuthorizations.add("api_key", new window.SwaggerClient.ApiKeyAuthorization("Authorization", "Bearer " + token, "header"));
            console.log("authorization added: Bearer = " + token);
        }
    }

})();

0

pour le porteur de jeton, je l'ai fait de cette façon:
J'ai utilisé swashbuckle seulement pour produire de l'arrogance.fichier json et utilisé Swagger.Net pour l'affichage de la dernière SwaggerUI version 3.xx) et de la personnalisation :

Donc dans mon projet références, I 'v ajoutée (via nuget) :

dans index.html:
```
<input id="bearer-code-input" type="text" placeholder="Enter Bearer Token here" style="width: auto" value="yourtoken" />
```
puis dans SwaggerUIBundle constructeur:
```
const ui = SwaggerUIBundle({
...,
requestInterceptor: function (req) {
req.headers = {
'Authorization': 'Bearer ' + document.getElementById('bearer-code-
input').value
'Accept': 'application/json',
'Content-Type': 'application/json'
};
return req;
},
... })
```
affichage du résultat:

J'ai également personnalisé beaucoup d'autres fonctions (Json modèle de classeur, la chaîne de requête de l'analyse, de la coutume SwaggerGenerator pour remplacer le comportement par défaut pour ConflictingActionsResolver pour être en mesure de gérer plusieurs parcours de parcours, mais il n'est pas dans le champ d'application de ce fil)

Vous devez vous connecter pour publier un commentaire.