Prodotto
Documento API
APIGit offre documenti API intuitivi e splendidamente tematizzati con varie modalità di visualizzazione. Puoi pubblicare un documento API da qualsiasi punto della cronologia del repository API, assicurandoti di avere sempre accesso all'ultima versione della tua documentazione. Inoltre, puoi anche indirizzare il tuo dominio ai documenti pubblicati, permettendoti di presentarli nello stile del tuo marchio. Semplifica la condivisione della documentazione API con team interni e partner esterni, pur mantenendo un aspetto coerente e professionale.
Documenti API eleganti e chiari
Un documento API pubblicato comprende due componenti: specifiche API e documenti markdown, entrambi ricavati dai file nel repository API. Puoi pubblicare più documenti API come versioni diverse e passare facilmente da uno all'altro.
Modalità di visualizzazione delle specifiche API: impostazione predefinita
I documenti delle specifiche API possono essere visualizzati in diverse modalità, fornendo una comprensione completa dell'API. Le modalità supportate includono: la visualizzazione predefinita, l'interfaccia utente spavalda e la modalità codice non elaborato. Ciò consente di visualizzare e interagire con la documentazione dell'API nel modo più adatto alle proprie esigenze.
Modalità di visualizzazione delle specifiche API: modalità interfaccia utente spavalda
Nella modalità dell'interfaccia utente di Swagger, puoi visualizzare la documentazione API nel tradizionale tema swagger, fornendo un'interfaccia familiare e facile da usare per comprendere e interagire con l'API.
Modalità di visualizzazione delle specifiche API - Modalità codice
In modalità codice, puoi visualizzare i file delle specifiche API non elaborati, fornendo un accesso diretto al codice sottostante, semplificando la revisione e apportando modifiche se necessario.
Documenti di markdown
I documenti Markdown sono inclusi anche nei documenti API pubblicati. Forniscono una posizione ideale per presentare i tuoi concetti di progettazione e la logica di business alla base delle API. Inoltre, supportiamo anche l'impostazione predefinita e la modalità codice per i documenti markdown, che ti consente di visualizzare e rivedere i documenti nel modo più adatto alle tue esigenze.
Dominio personalizzato
Dopo aver impostato un dominio personalizzato, puoi utilizzare un record CNAME per indirizzare il tuo dominio ai documenti pubblicati, consentendoti di visualizzarli con il tuo nome e URL.
© 2024 APIGit Inc.