Verwendung von ApiDoc

Dieser Artikel führt Sie in die Verwendung von ApiDoc ein.

Erklärung

apiDoc creates a documentation from API annotations in your source code

apiDoc ist ein Schnittstellendokument und wie es erstellt wird. Es handelt sich um einen Schnittstellenkommentar basierend auf Ihrem Quellcode. Wir müssen nur die entsprechende Dokumentation für die Schnittstelle schreiben und dann das Schnittstellendokumentationstool zur Generierung von apiDoc verwenden, um die Dokumentation für eine einfache Verwaltung und Anzeige zu generieren.

Konfigurationsmethode

1. Installieren Sie apidoc (was ist npm??? Fragen Sie Ihre Front-End-Klassenkameraden.)

npm install apidoc -g

http-server installieren

npm install http-server -g

2. Dokumentation (offizielles Beispiel) zur Schnittstelle hinzufügen und vor der Controller-Eingabemethode hinzufügen.

/**
 * @api {get} /user/:id Request User information
 * @apiName GetUser
 * @apiGroup User
 *
 * @apiParam {Number} id Users unique ID.
 *
 * @apiSuccess {String} firstname Firstname of the User.
 * @apiSuccess {String} lastname  Lastname of the User.
 */

3. Erstellen Sie apidoc.json (offizielles Beispiel)

{
  "name": "example",
  "version": "0.1.0",
  "description": "apiDoc basic example",
  "apidoc": {
    "title": "Custom apiDoc browser title",
    "url" : "https://api.github.com/v1"
  }
}

4. Führen Sie

apidoc -i app/Http/Controllers -o apidoc/

aus

Zusätzliche Bemerkungen

http-server api/doc

Referenz

http://apidocjs.com/

Das obige ist der detaillierte Inhalt vonVerwendung von ApiDoc. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!