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.