diff --git a/docs/en/develop/dev-config.md b/docs/en/develop/dev-config.md index 6fb8669e6..77d3e10a2 100644 --- a/docs/en/develop/dev-config.md +++ b/docs/en/develop/dev-config.md @@ -44,3 +44,7 @@ When using `dev:local` to start locally, the environment variable `NEXT_PUBLIC_A In production environments, the frontend will be precompiled into static files and provided by the backend, and the frontend will automatically access the backend address on the same domain. ::: + +## API Documentation + +We will write API documentation in APIFox before developing each interface. Please refer to [API Documentation(Chinese)](https://ok52vhsenr.apifox.cn/). \ No newline at end of file diff --git a/docs/zh/develop/dev-config.md b/docs/zh/develop/dev-config.md index 3fdb0590c..d1dd0194f 100644 --- a/docs/zh/develop/dev-config.md +++ b/docs/zh/develop/dev-config.md @@ -43,4 +43,8 @@ npm run dev:local 本地使用`dev:local`启动时,会携带环境变量`NEXT_PUBLIC_API_BASE_URL`,该变量会自动被前端使用,以确保前端可以访问到本地启动的后端的`5300`端口。如果您需要修改所使用的后端地址或端口,请到`web/package.json`文件中修改`scripts`中的`dev:local`命令。 生产环境中,前端会被预编译成静态文件,由后端提供服务,前端会自动访问同域的后端地址。 -::: \ No newline at end of file +::: + +## API 文档 + +我们在开发每个接口之前都会先在 APIFox 中编写接口文档,请查看 [API 文档](https://ok52vhsenr.apifox.cn/)。 \ No newline at end of file