Skip to content

Commit 2396b4f

Browse files
authored
docs: add question for proposal
1 parent d884b81 commit 2396b4f

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

doc/proposals/2025/gsoc/idea_april_lin_api_explorer.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,14 @@ I think there are two ways to design the automated pipeline: the first is to use
116116
- **OpenAPI**: Use existing libraries (e.g., Swagger/OpenAPI parser libraries) to read and interpret JSON or YAML specs.
117117
- **HTML**: Perform DOM-based parsing or use regex patterns to identify endpoints, parameter names, and descriptions.
118118
- **Markdown**: Utilize Markdown parsers (e.g., remark, markdown-it) to convert the text into a syntax tree and extract relevant sections.
119+
120+
## Questions
121+
122+
1. **Database Selection**
123+
- Which type of database should be used for storing API templates and methods? Are there any specific constraints or preferences (e.g., relational vs. NoSQL, performance requirements, ease of integration) we should consider?
124+
125+
2. **Priority of Automated Parsing**
126+
- What is the preferred approach for automated parsing of OpenAPI/HTML files? Would an AI-based parsing solution be acceptable, or should we prioritize rule-based methods for reliability and simplicity?
127+
128+
3. **UI Interaction Flow**
129+
- Can I add a dedicated “api explorer” menu in the left navigation bar for api explorer?

0 commit comments

Comments
 (0)