【问题标题】:How to generate documentation for existing angularjs site using swagger如何使用 swagger 为现有的 angularjs 站点生成文档
【发布时间】:2016-02-04 09:28:36
【问题描述】:

我正在使用angular.js 制作的现有网站,该网站使用一些 REST API。
有没有办法从客户的角度从现有网站开始生成swagger 文档,至少是一些骨架?
我想避免写文档乞讨。最好根据现有代码生成一些起点文档,然后对其进行改进。

有可能吗?

【问题讨论】:

  • 我真的不明白 Swagger 和 Angular 有什么关系 - Swagger 不是主要用于记录 REST API 吗?
  • 是的。我的 Angular 应用程序使用 REST API,所以有没有办法从消费者的角度生成一些 API,或者我需要服务器端代码才能生成一些 API 文档?
  • 啊,我明白你的意思了。不,Swagger 通过代码注释或定义模式在服务器端运行。据我所知,不幸的是,没有办法从客户端自动生成它。
  • 谢谢。您可以发表您的评论作为答案以接受它吗?

标签: angularjs documentation swagger


【解决方案1】:

据我所知,无法从客户端使用 Swagger 自动生成文档。您要么必须在服务器端添加代码注释,要么使用 http://editor.swagger.io 之类的东西手动创建架构。

【讨论】:

    猜你喜欢
    • 2016-02-05
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2016-12-11
    • 1970-01-01
    • 2015-06-17
    • 1970-01-01
    相关资源
    最近更新 更多