[Question] What is recommended practices for developers when making changes to our api specification

Aperta
#740 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
azure
Ambito
api, devops

Direzione di ricerca

Inizia con il flusso della pipeline di caricamento ed estrazione della specifica API descritto nell’issue, inclusi gli artefatti generati e il passaggio di pubblicazione in APIM. Esamina come gli URL dei servizi, i protocolli di sicurezza OAuth, gli esempi e le proprietà aggiunte sono rappresentati nella specifica estratta e in APIM. Il lavoro sarà considerato completato quando sarà definito un approccio per modificare parti selezionate della specifica senza cancellare le impostazioni di APIM né rimuovere l’API dal portale per sviluppatori.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Release version

Not sure

Question Details

Creating a new API in APIM from an API spec (using swagger) is super easy with some caveats.

Go into API, upload openAPI spec, run extract pipeline, the artifacts here and there, and then commit and publish.

Where i'm struggling is making modifications. There are so many things that differ when running in APIM vs what is extracted from a swagger API spec makes this very difficult. For example, all my serviceUrls, OAuth security protocols, examples, etc get wiped or modified even adding a single property to an API is annoying.

We basically have to manually do everything, or optionally completely republish/extract but that removes API from developer portal during the process.

Expected behavior

Maybe break up api specification up in a way that might be easier to digest and only need to modify particular files. Maybe provide a openapi specification (extracted from service) and have overrides in other configuration files for securityschemas as an example.

Actual behavior

everything is contained in api specification

Reproduction Steps

I think i put enough detail above.

Lingua principale
C#
Stelle
448
Fork
247
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Azure/apiops

Tutte le issue di Azure/apiops

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.