既存のnodejs APIを文書化するにはどうすればよいですか？

Question

New to Node、そして、同じことをするために複数のライブラリが本当に不満です。私はどこにも行きません。

私は既存のNode + Expressアプリケーションを持っており、スワッガードキュメントを統合する必要があります。 見つかった最も有用なスレッドはthis oneでした。しかし、それは単に並列api-docs.jsonファイルを持つことを期待しています。これは自動的には生成されません。

コントローラー内の各APIをドキュメント化し、ドキュメントを生成したいと考えています。誰かが私により良いリソースを指すことができますか？

Answer 1

最後に、私はそれがで

npm install -g swagger-ui

設定を闊歩闊歩-UIの依存関係を追加Swagger-UIパッケージ

を追加swagger-jsdoc

ステップ

• で動作させることができましたあなたのserver.jsファイル

  var swaggerJSDoc = require('swagger-jsdoc'); var options = { swaggerDefinition: { info: { title: 'Hello World', // Title (required) version: '1.0.0', // Version (required) }, }, apis: ['./routes.js'], // Path to the API docs }; var swaggerSpec = swaggerJSDoc(options); app.get('/api-docs.json', function(req, res) { res.setHeader('Content-Type', 'application/json'); res.send(swaggerSpec); }); app.use('/api/docs',express.static('./node_modules/swagger-ui/dist'));

• は

/** * @swagger * resourcePath: /api * description: All about API */

/** * @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); });

• あなたのコントローラ機能にで入手可能な闊歩のドキュメントを闊歩コメントを追加しますhttp://localhost:3000/api/docs/?url=/api-docs.json