Swagger

swagger

#swagger

Sommario

Di

1

Capitolo 1: Iniziare con lo spavalderia

2

Osservazioni

2

Examples

2

Introduzione - Installazione - Configurazione (sviluppo in Node.js)

2

Capitolo 2: spavalderia-ui

4

Osservazioni

4

Examples

4

swagger-ui con maglia REST WS

4

Capitolo 3: springfox

12

Examples

12

Sostituisci i messaggi di risposta predefiniti

12

Disabilita i messaggi di risposta predefiniti

12

Imposta i tuoi messaggi di risposta predefiniti

12

Imposta springfox usando swagger-ui in spring-boot

12

# 1 Ottenere springfox con Maven

13

# 2 Configura la tua applicazione per usare lo swagger

13

# 3 Documenta la tua API

13

Titoli di coda

15

Di

You can share this PDF with anyone you feel could benefit from it, downloaded the latest version from: swagger

It is an unofficial and free swagger ebook created for educational purposes. All the content is extracted from Stack Overflow Documentation, which is written by many hardworking individuals at Stack Overflow. It is neither affiliated with Stack Overflow nor official swagger.

The content is released under Creative Commons BY-SA, and the list of contributors to each chapter are provided in the credits section at the end of this book. Images may be copyright of their respective owners unless otherwise specified. All trademarks and registered trademarks are the property of their respective company owners.

Use the content presented in this book at your own risk; it is not guaranteed to be correct nor accurate, please send your feedback and corrections to info@



1

Capitolo 1: Iniziare con lo spavalderia

Osservazioni

Questa sezione fornisce una panoramica di cosa sia lo swagger e perch? uno sviluppatore potrebbe volerlo utilizzare.

Dovrebbe anche menzionare qualsiasi argomento di grandi dimensioni all'interno di spavalderia e collegarsi agli argomenti correlati. Poich? la Documentation for swagger ? nuova, potrebbe essere necessario creare versioni iniziali di tali argomenti correlati.

Examples

Introduzione - Installazione - Configurazione (sviluppo in Node.js)

Introduzione:

Swagger ? un insieme di regole / specifiche per un formato che descrive le API REST. Fornisce un potente e attivamente sviluppato ecosistema di strumenti attorno a questa specifica formale come generatori di codice ed editori. La parte migliore di Swagger ? che la documentazione di metodi, parametri e modelli ? strettamente integrata nel codice del server, consentendo alle API di rimanere sempre sincronizzate. Ecco un link che fornisce una breve panoramica di ci? che ? spavalderia: iniziare.

Specifiche di scrittura:

Le specifiche possono essere scritte in JSON o YAML. E cos? facciamo il file swagger.json o swagger.yaml di conseguenza. L'editor online pu? essere utilizzato per creare il file. Ecco un link che descrive la sintassi per le specifiche:

Modi per usare lo spavalderia:

1. Approccio API-first (approccio Top-down): Usa editor swagger Scrivi definizioni swagger Usa swagger-codegen e swagger-ui per generare API

2. Primo approccio al servizio (approccio bottom-up): sviluppo classi di risorse JAX-RS usando annotazioni swagger Usa swagger-core per generare automaticamente le definizioni swagger Usando swagger-codegen e swagger-ui per generare API e documentazioni client. Quanto sopra pu? essere fatto durante la generazione di Maven durante il plug-in swavger maven.

Installazione e configurazione

In questa sezione installeremo swagger, configureremo l'interfaccia utente swagger e genereremo il lato server e l'SDK client che lo utilizza. Per installare swagger usando Node package manager eseguire il seguente comando:



2

npm install -g swagger

L'uso del flag '-g' assicurer? che il modulo sia installato a livello globale. Successivamente, creeremo un progetto usando il seguente comando:

swagger project create

Questo richieder? all'utente di selezionare un framework per lo sviluppo delle API REST. Express pu? essere selezionato per lo stesso. Questo creer? la directory del progetto con i seguenti elementi e un file README.md in ciascuno di essi:

? API / controllori / aiutanti / schernisce / spavalderia /

? config / ? test/

API / controllori / aiutanti

? app.js ? package.json

Il server ? fondamentalmente pronto ora e pu? essere avviato utilizzando questo comando per essere eseguito nella radice del progetto:

swagger project start

Se il server host ? impostato come localhost e il numero di porta non viene modificato nel file app.js , il server viene avviato all'indirizzo: Ora l'interfaccia utente swagger pu? essere utilizzata per sviluppare ulteriormente le nostre API REST. Questo pu? essere avviato in un nuovo terminale usando:

swagger project edit

Questo aprir? l'editor swagger in una scheda del browser su una porta generata casualmente. Un esempio di esempio La richiesta GET pu? essere vista gi? presente nel file swagger.yaml. Qualsiasi ulteriore modifica a questo file causer? il riavvio del server autonomamente.

Nella sezione dei percorsi, il valore utilizzato per x-swagger-router-controller dovrebbe essere il nome del file javascript nella cartella dei controller. Come esempio, hello_world.js dovrebbe essere presente nella directory dei controller. Inoltre, il valore per parametro operationId rappresenta il nome della funzione nel file javascript sopra. ? qui che deve essere scritta la logica aziendale. Pertanto, la nostra configurazione swagger ? completa e pu? essere utilizzata per sviluppare ulteriormente la nostra API.

Leggi Iniziare con lo spavalderia online:



3

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download