api - 如何找到我网站的所有 API?

标签 api go endpoint

<分区>

首席开发人员上周突然离开了我的公司。 API 没有记录。所以我正在努力发现每个 API 是什么,然后在 JIRA 中记录它们。我们使用 Golang 作为后端。我尝试使用 Charles Proxy、Fiddler、JMeter 和 Chromes 检查器/网络,但没有显示 API。我有技术限制,我想尽快找到我们所有的 API。我的一位开发人员告诉我下载并安装 Goland。并指示我执行以下操作

"byte.*(okay|StatusOK|成功) 和 mux.nomapi. 获取端点和那些正在使用它的端点,但不确定是否所有端点都使用 mux 和 nomapi

使用 goland,您可以轻松地跳转到定义,这对于不熟悉的代码非常有用 并找到用法”

不确定他说的所有这些是什么意思。

有人能指出我正确的方向吗?

最佳答案

这实际上取决于您的开发人员用来创建 API 的内容。最好的办法是解析源代码,而不是使用 Chrome 检查器之类的工具。您想要找到的是 API 处理程序的路由器。路由器基本上是一个将 API 端点(如 /api/v1/login/)映射到处理调用的 Go 函数(适本地称为处理程序)的结构。但是,不幸的是,根据使用的框架/库以及代码的结构,这可能在很多非常不同的地方。所以,虽然我不能给你一个明确的答案,但我可以给你一些建议。

  1. 您将必须阅读 Go 代码。没有办法解决它。这并不难,所以不要害怕。
  2. 很有可能存在一个或多个名为 route.go 或 routes.go 或 router.go 或类似名称的文件。如果您发现类似的东西,请先看那里。
  3. 如果您找不到任何路由,请使用 Chrome 检查器的网络选项卡查看您的前端发出的 API 调用,然后 grep 端点的代码。比如说,如果您的前端对 http://api.domain.com/api/v1/accounts/ 进行 API 调用,请在代码中搜索 /accounts/ 并对于 /api/v1/ 如果这对 /api/ 不起作用。运气好的话,第二次或第三次搜索可能会将您带到应用程序的根路由器,您将能够从那里对其进行跟踪。
  4. 如果您找到一些路由(或路由处理程序),但不是全部,请在文件顶部查找包名称。如果它不是 main,特别是如果它被称为 routes 之类的东西,请查找导入此包的任何地方(只需 grep 查找所有文件中的包名称和忽略包声明本身)。
  5. 可能最受欢迎的路由器库是 gorilla mux .检查代码中是否有任何对 github.com/gorilla/mux 的引用,以防它被使用。如果使用了它,请查找其中包含 HandleFunc 的任何代码。这些将成为路由器。如果根本不使用路由器库,情况也是如此。

祝你好运。

关于api - 如何找到我网站的所有 API?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/52278556/

相关文章:

php - 这是使用 PHP CURL 发出 API 请求的最佳方式吗?

api - Slack API - 固定消息

firebase - 查询与空字段的比较

api - 如何使用完整的 Web 前端扩展 heroku-buildpack-core-data

node.js - BelongsToMany 关系 - Sequelize

user-interface - 为什么找不到来自 andlabs/ui 包的组件

go - 试图安装 golang 命令,但它显示找不到命令

java - 使用 Jax-WS 端点发布 WS

azure - 配置没有公共(public) URL 的 Azure 应用服务

rest - 将小型 REST 端点添加到 Azure 辅助角色的最简单代码片段