gristlabs/grist-core

[Enhancement] Display API endpoint on API key screen

Open

#741 创建于 2023年11月11日

在 GitHub 查看
 (2 评论) (0 反应) (0 负责人)TypeScript (3,613 star) (168 fork)batch import
enhancementgood first issue

描述

Display the endpoint for API requests next to the API key. This will help to get started with using the API. Perhaps even display the curl command to test the API.

贡献者指南

技术栈
typescript
领域
frontendbackend
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic understanding of API keysfamiliarity with Grist's API structure
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Start by locating the API key screen component in the Grist frontend codebase, likely under a directory like 'app/client/components' or similar. Look for where the API key is displayed and consider how to add the endpoint URL next to it. The backend API endpoints are defined in the server side; you may need to confirm the correct endpoints from the documentation or by looking at server routes. Optionally, adding a curl command could be done by constructing it from the endpoint and API key. Check existing comments for any hints from maintainers.