so integrieren Sie stolzieren mit meiner express-Anwendung

Immer ich verwendet, um meine Knoten side services zu einigen anderen teams mit der richtigen Dokumentation. Basierend auf dieser Dokumentation werden Sie meine Dienste nutzen.

Bezüglich dieser, wenn ich Sprach mit einigen anderen Kerl. Er schlug mich zu verwenden swagger. Aber ich habe keine Idee, wie das zu integrieren, um meine Anwendung.

Meine Bewerbung geschrieben in Express. Ich habe Suche in google, habe ich nicht finden, eine gute tutorial. Wenn jemand bereits implementiert hat, kann Sie mir empfehlen. Welches Modul ist gut, und wie.

Auch einfach nur neugierig zu wissen, sind Sie alle anderen Bibliotheken, wie swagger unterstützt Node Plattform.

Dank

InformationsquelleAutor grandhi | 2015-12-13

  1. 8

    Habe ich Erfahrung mit der Dokumentation von Express-API mit einem express-Modul (swagger-node-express). Ich habe auch Erfahrung mit Dokumentation eines Express-API mit der manuellen Swagger JSON-docs.

    Ich würde empfehlen, nicht das binden Sie sich unten, um ein Modul für Ihr Fors docs. Die meisten der Module (und vor allem swagger-Knoten-express) Sie zwingen, zu schreiben, Ihre Express-code anders zu handhaben in der Dokumentation. Beim manuellen schreiben von Swagger docs mit JSON, Sie sind in der Lage zu schreiben, Express-und entkoppeln Sie die Dokumentation von Ihrem routing.

    Verwenden Swagger UI Stil Ihrer Dokumentation und fügen Sie es zu Ihrem web-Seite.

    Hier sind einige Ressourcen, die Sie verwenden können, wenn Sie anfangen:

    Swagger-Editor - Bearbeiten Sie Ihre stolzieren docs und sehen Sie Ihre änderungen live update

    Swagger Docs - Swagger Spezifikationen für JSON

    Tutorial - Diese nutzt eine ältere version von Stolzieren, werden Sie sicher, dass Sie Migration Swagger upgrade auf die neueste version

    Werfen Sie auch einen Blick auf diese Antwort erklären Sie den Unterschied zwischen Hand-und Modul-basierte swagger doc generation -> HIER.

    InformationsquelleAutor Mike

  2. 1

    Ich bin nicht ganz klar, was deine Fragen, aber ich denke du suchst so etwas: Fors-tools

    Ich dieses Modul verwenden, und es war großartig. Es macht einige middleware, die Sie binden können, um die Express app, die Sie erstellen. Zum Beispiel, wenn Sie Ihre service-dokumentiert und dass die Dokumentation ist Swagger kompatibel, dann übergeben Sie das Dokument an die middleware. Die middleware hat einige wunderbare Dinge wie Verkabelung-request-Handler auf der Grundlage der Definitionen, die sich in Ihre Dokumentation und Validierung von Anforderungen gegen die Definitionen finden Sie in Ihrer Dokumentation.

    Es hat eine große tutorial und es ist super einfach, um die Einrichtung zu erhalten. Ich hoffe, das hilft und ist entlang der Linien von, was Sie gesucht haben.

    InformationsquelleAutor Michael Jonas

  3. 1

    Ich habe vor kurzem über die Implementierung der API-Dokumentation mit swagger. Benutzt habe ich "swagger-ui-express" npm-Modul, um es zu implementieren.
    Erstellt von JSON zur Laufzeit, d.h., sobald die server laufen beginnt, ich die erfassten Daten und modifiziert nach Fors Spezifikationen wie unten Datei.

    https://editor.swagger.io/ Hier sehen Sie die swagger technische Daten im JSON-Format.

    Bedürfen der "swagger-ui-express" - Modul, erstellen Sie eine JSON-und Futtermittel, die Datei zu swaggerui als unten. 

    const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

    InformationsquelleAutor Mythili

  4. 0

    Benutze ich swagger mag das, weil es gibt mir die live-docs automatisch auf meine ausdrückliche apps:

    • API-Spezifikation: dokumentiere ich meinen code mithilfe der Open API (Fors) Spezifikation in YAML-format. Dies wird erreicht durch Fors-jsdoc.
    • Live docs: swagger-ui-express ", fügt middleware, um Ihre express-app dienen, die Swagger-UI gebunden, um Ihre Fors-Dokument. Dies dient als lebendige Dokumentation für Ihre API gehostet von innerhalb der app."

    Dann ist es nur noch eine Frage der Schaffung der route, wo Sie wollen Ihre Dokumente zu Leben:

    const swaggerSpec = swaggerJSDoc({
  swaggerDefinition: {
    info: {
      title: 'My App API',
      version: '1.0.0'
    }
  },
  apis: ['./routes/index.js']
});

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));

    Sehen, wie swagger-ui-express han-built-in Unterstützung für Fors-jsdoc. Lesen swagger-ui-express und Fors-jsdocs erste Schritte Dokumentation für mehr info.

    API-Spezifikation Beispiel:

    Stammt aus der Fors-jsdocs erste Schritte Dokumentation.

    /**
 * @swagger
 * /login:
 *   post:
 *     description: Login to the application
 *     produces:
 *       - application/json
 *     parameters:
 *       - name: username
 *         description: Username to use for login.
 *         in: formData
 *         required: true
 *         type: string
 *       - name: password
 *         description: User's password.
 *         in: formData
 *         required: true
 *         type: string
 *     responses:
 *       200:
 *         description: login
 */
app.post('/login', function(req, res) {
  res.json(req.body);
});

    Generiert docs Beispiel:

    Würden Sie sehen fast wie die Swagger-UI-Beispiel.

    Darf ich wissen, Wie Sie zum trennen der autorisierten API-und nicht-autorisierte API in Swagger-UI mit, die Sie oben Verfahren?
    Ich würde vorschlagen, Sie Folgen Mike ' s Antwort da hab ich auch abgeschlossen, ist es besser so. Mit jsons entkoppelt von der code

    InformationsquelleAutor Martin Schaer

Schreibe einen Kommentar