Closed Redish101 closed 3 months ago
The latest updates on your projects. Learn more about Vercel for Git ↗︎
Name | Status | Preview | Comments | Updated (UTC) |
---|---|---|---|---|
reblog-docs | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Jul 25, 2024 8:15am |
[!WARNING]
Rate limit exceeded
@Redish101 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 11 minutes and 22 seconds before requesting another review.
How to resolve this issue?
After the wait time has elapsed, a review can be triggered using the `@coderabbitai review` command as a PR comment. Alternatively, push new commits to this PR. We recommend that you space out your commits to avoid hitting the rate limit.How do rate limits work?
CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our [FAQ](https://coderabbit.ai/docs/faq) for further information.Commits
Files that changed from the base of the PR and between b2ec7b65fec6903ec2747e98fedd6a278e76047d and 59674488bb8248c365583554fcf465690fcd6f5b.
此次更改显著优化了API文档结构,所有请求参数都集中到单个对象中,替代了之前的formData
。这种结构化的方式提升了API的可读性和可维护性,通过引入详细的schema定义,使得接口使用更为明确,开发者更易理解和实现所需参数。
文件 | 更改摘要 |
---|---|
internal/docs/docs.go |
更新参数定义,从formData 改为使用带schema的body 参数,添加多个新schema定义。 |
internal/docs/swagger.json |
转换多个API端点参数为结构化的body 参数,集中在特定schema中,提高API文档的清晰度和可维护性。 |
internal/docs/swagger.yaml |
添加新的请求和响应参数结构,利用body 格式替代formData ,提高参数定义的清晰性和严谨性。 |
packages/dashboard/src/pages/article/*.tsx |
将文章创建和编辑请求中的formData 替换为结构化的data 对象。 |
packages/dashboard/src/pages/friend/*.tsx |
更新好友管理功能,直接发送values 对象,简化提交处理。 |
packages/dashboard/src/pages/init.tsx |
简化表单提交,直接使用values 对象。 |
packages/dashboard/src/pages/login.tsx |
更新请求体,从formData 改为values 对象。 |
packages/dashboard/src/pages/site/index.tsx |
提交表单时直接发送一个简单对象,替换FormData 。 |
packages/dashboard/src/utils/fetcher.ts |
useApi 函数签名更新,接受更灵活的opts 参数。 |
packages/themekit/package.json |
更新@reblog/themekit 包的版本号从0.1.3 到0.1.4 。 |
packages/themekit/src/utils/api.ts |
将post 方法的body 参数类型从FormData 更新为any ,提高输入处理的灵活性。 |
server/handler/*.go |
多个处理函数中参数大幅简化,统一为结构化的body 参数,更新文档以反映新结构。 |
sequenceDiagram
participant Client
participant API
participant Database
Client->>API: 发送请求 (带有结构化主体)
API->>Database: 查询或更新数据
Database-->>API: 返回结果
API-->>Client: 返回响应
🐇 在月光下跳跃欢快,
API更新如春风般,
参数整齐无需愁,
清晰结构共欢笑!
数据流畅如小溪,
开发者乐无比!
让我们一起庆祝这些变化! 🎉
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
后端虽兼容json与formData两种请求体,但dashboard和themekit默认使用formData,但formData疑似会导致vercel环境下405错误,此pr将dashboard与themekit中的请求体改为json。
Summary by CodeRabbit
新功能
useApi
函数接口,增强了请求参数的灵活性和可读性。修复
版本更新
@reblog/themekit
包的版本号,从0.1.3
升级到0.1.4
。