Javascript 如何记录现有的nodejsapi？

对Node来说是个新手，而且对多个库做同样的事情感到非常沮丧。我不去任何地方

我有现有的Node+express应用程序，需要集成swagger文档。 我发现最有用的线索是。但它只希望有一个并行的api-docs.json文件。这不是自动生成的

---

我想记录控制器中的每个API，并生成文档。有人能给我指点更好的资源吗？

最后我终于可以用它了

台阶

• 添加包
• 添加招摇过市ui依赖项

  npm安装-g-swagger用户界面

• 在server.js文件中配置swagger

  var-swagger-jsdoc=require（'swagger-jsdoc'）；
  变量选项={
  大摇大摆的定义：{
  信息：{
  标题：“Hello World”，//标题（必填）
  版本：“1.0.0”，//版本（必需）
  },
  },
  API:['./routes.js']，//API文档的路径
  };
  var swaggerSpec=swaggerJSDoc（选项）；
  app.get（'/api docs.json'，函数（req，res）{
  res.setHeader（'Content-Type'，'application/json'）；
  res.send（招摇过市）；
  });
  app.use（'/api/docs'，express.static（'/node_modules/swagger ui/dist'）
  

• 向控制器函数添加招摇注释

/**
*大摇大摆
*资源路径：/api
*描述：所有关于API
*/

/**
*大摇大摆
*/登录名：
*职位：
*描述：登录到应用程序
*产生：
*-应用程序/json
*参数：
*-名称：用户名
*描述：用于登录的用户名。
*in:formData
*必填项：true
*类型：字符串
*-名称：密码
*描述：用户的密码。
*in:formData
*必填项：true
*类型：字符串
*答复：
*       200:
*说明：登录
*/
app.post（'/login'，函数（req，res）{
res.json（请求主体）；
});


招摇过市文件可在

我终于能够让它与

台阶


添加包
添加招摇过市ui依赖项

npm安装-g-swagger用户界面

在server.js文件中配置swagger

var-swagger-jsdoc=require（'swagger-jsdoc'）；
变量选项={
大摇大摆的定义：{
信息：{
标题：“Hello World”，//标题（必填）
版本：“1.0.0”，//版本（必需）
},
},
API:['./routes.js']，//API文档的路径
};
var swaggerSpec=swaggerJSDoc（选项）；
app.get（'/api docs.json'，函数（req，res）{
res.setHeader（'Content-Type'，'application/json'）；
res.send（招摇过市）；
});
app.use（'/api/docs'，express.static（'/node_modules/swagger ui/dist'）

向控制器函数添加招摇注释


/**
*大摇大摆
*资源路径：/api
*描述：所有关于API
*/

/**
*大摇大摆
*/登录名：
*职位：
*描述：登录到应用程序
*产生：
*-应用程序/json
*参数：
*-名称：用户名
*描述：用于登录的用户名。
*in:formData
*必填项：true
*类型：字符串
*-名称：密码
*描述：用户的密码。
*in:formData
*必填项：true
*类型：字符串
*答复：
*       200:
*说明：登录
*/
app.post（'/login'，函数（req，res）{
res.json（请求主体）；
});


招摇过市文件可在

在SO中，征求建议是不合主题的。考虑坚持一种方法，一旦你找到了一个特定的问题。你可以用它来做文档，我没有用这个来作为答案，因为这是一个非常自以为是的问题建议，在这个问题上是不重要的。考虑坚持一种方法，一旦你找到一个特定的问题，你可以用它来做文档，我没有用这个来回答这个问题，因为这是一个很固执的问题。