Tag: api doc

ApiDoc错误：parsing器插件“apimethod”未find: 我用Slim Framework编写了一个RESTful API。对于我想用户APIDoc的文档。我通过npm安装了apidoc（没有sudo没有工作） $ sudo npm install apidoc -g 我将这个示例注释插入到一个项目文件（users.router.php） /** * @ApiDescription(section="User", description="Get information about user") * @ApiMethod(type="get") * @ApiRoute(name="/user/get/{id}") * @ApiParams(name="id", type="integer", nullable=false, description="User id") * @ApiParams(name="data", type="object", sample="{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}") * @ApiReturnHeaders(sample="HTTP 200 OK") * @ApiReturn(type="object", sample="{ * 'transaction_id':'int', * 'transaction_status':'string' * }") */ 我还添加了一个apidoc.json文件。然后我尝试通过调用生成文档 $ apidoc -i App/Routers/ -o public/doc/ […]

Sails.js + apidocjs + grunt – 自动生成文档: 我是Sails.js和Node.js的新手，我在为应用程序创build文档时遇到了问题。这是我的步骤：通过安装apidoc： npm install apidoc -g 安装grunt模块： npm install grunt-apidoc –save-dev 添加grunt.loadNpmTasks('grunt-apidoc'); Gruntfile.js 创buildgrunt.initConfig文件，并把： apidoc: { myapp: { src: "api/controllers/", dest: "apidoc/" } } 然后我试图运行多个东西，没有一个产生我的api文档：帆升降机咕噜咕噜默认节点app.js 如果我通过apidoc -i api/controllers/ -o apidoc/手动运行它，它工作正常。我究竟做错了什么？怎么做？

公开定义的APIDoc定义: 我正在Sails.js应用程序中使用apiDoc文档。而且，上周我看到有人在一个名为api_definitions.js的文件中定义了多个控制器正在使用的响应例 /* * @apiDefine UserSuccessExample * @apiSuccessExample Success-Response: * HTTP/1.1 201 OK * { * "message": "User Created successfully", * "user" : { * "displayname": "somedisplayname", * "lastname": "ALastName", * "firstname": "AFirstName", * "email": "sososo@soos.so", * "phonenumber": "0839293288" * }, * "token" : "ey.jkernekrerkerkeekwewekwbejwbewbebewbwkebebbwbeibwubfebfebwiee" * } */ 而且，在每个控制器中，使用正常的使用参数 @apiUse UserSuccessExample引用它。但是当我尝试它时，我的控制台中出现错误，说没有定义：错误 error: […]

需要为使用nodejs / express编写的现有应用程序创buildapi文档: 我有几个私人apis写在普通的旧expression。有时间让它出来，并提供一些API文件。我不想（至less）它重写我的快速应用程序，以将API文档整合到代码中。主要是因为我不确定使用什么框架或规范来logging我的api，我并不想locking在一个特定的东西。我想将文档作为我的API下的子资源的一部分（即我不想运行不同的服务器或子域）。也许'/ api / docs'。加号也可以是我可以embedded到我的应用程序，可以parsing文档，至less提供一个很好的文档在HTML中的表示（UI API交互是一个加号）的用户界面。像https://github.com/swagger-api/swagger-node-express这样的东西很酷，但是需要我重新编写我所有的快速代码才能集成大举的东西。在那个时候，我有一个很大的投资，并紧紧地联系在一起。有没有一种方法可以放出大招或碘酒，或者其他的东西来logging我的api的方式是对现有路线的微创？编辑：我可以从一个手写的文档中提供Swagger规范。我看到的问题是，你必须在swagger文档中定义basePath。这实际上并不能让我轻松部署在不同的领域。