J'ai gĂ©nĂ©rĂ© un SDK JavaScript, mais je ne sais pas trop comment dĂ©finir les en-tĂȘtes d'authentification. J'aimerais pouvoir dĂ©finir les en-tĂȘtes d'authentification utilisĂ©s pour toutes les futures demandes via une sorte de paramĂštre d'en-tĂȘte par dĂ©faut. J'ai essayĂ© de dĂ©finir le ApiClient.defaultHeaders
comme ci-dessous, mais sans succÚs :
Mise Ă jour : j'ai mis Ă jour le code ci-dessous montrant comment j'ai ajoutĂ© les en-tĂȘtes aux demandes faites par connAPI
, mais ce code est certainement loin d'ĂȘtre idĂ©al. Il doit y avoir un autre moyen de dĂ©finir ces en-tĂȘtes d'authentification d'une maniĂšre plus flexible/programmatique.
import telnyxSDK from 'telnyx-sdk';
const connAPI = new telnyxSDK.ConnectionsApi();
connAPI.apiClient.defaultHeaders = {
'x-api-user': 'my-username',
'x-api-token': 'my-token'
};
let _payload = {
connection_name: 'test-name',
tech_prefix: 'test-prefix',
active: true
};
return connAPI.addConnection(_payload).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.log(error);
});
La demande est effectuĂ©e, mais sans aucun des en-tĂȘtes d'authentification.
S'il vous plaĂźt conseiller, merci!
2.2.3 (via l'image docker swagger-codegen-cli)
https://api.telnyx.com/mission_control_docs
swagger-codegen generate -i https://api.telnyx.com/mission_control_docs -l javascript
@dganoff si votre spécification openapi/swagger contient la définition de sécurité appropriée pour les points de terminaison, la documentation générée automatiquement doit contenir les exemples de code expliquant comment effectuer l'appel approprié.
Avez-vous eu l'occasion de consulter le document généré automatiquement dans le client API JS ?
@ wing328 Oui, j'ai <Name>Api.md
et ils ont tous une section pour "Autorisation" qui se lit "Aucune autorisation requise". Je suppose que c'est lĂ qu'il documenterait comment dĂ©finir les en-tĂȘtes d'authentification.
Je me demande si les opérations des path
dans notre spécification swagger doivent avoir une clé security
?
Oui, vous devrez ajouter security
à la définition du point de terminaison, par exemple https://github.com/swagger-api/swagger-codegen/blob/master/modules/swagger-codegen/src/test/resources /2_0/petstore.yaml#L183