Small-Api

一、背景和目标

背景： 现代软件应用程序日益依赖于各种API进行互动，从而简化开发、加快交付，并提高系统的可扩展性和灵活性。各种Api管理工具也层出不穷，例如PostMan、ApiPost、Apifox等，他们都是很成功的商业产品，他们的缺点也正是因为他们的商业化功能越来越多，体积越来越大我们不想要的功能也会被加载进入，如果计算机的配置相对不好的情况下，可能就会导致卡顿的问题。

目标： 构建一个高效、可视化、极简的Api管理工具，帮助开发者们有效的管理、控制其API。

二、功能需求

1. 项目管理

• 新建\删除项目：
  • 提供项目级管理Api。

2. API 创建与管理

• API定义：

  • 支持RESTful、GraphQL等主流API类型。
  • 提供简洁易用的界面用于定义API路径、方法（GET, POST, PUT, DELETE等）、请求参数、响应数据结构、状态码等。

• 文档生成：

  • 自动生成符合OpenAPI规范的API文档。
  • 支持在线预览和导出（HTML、PDF等格式）。

3. API 测试和调试

• 集成测试工具：
  • 提供接口测试工具，用于发送HTTP请求、查看响应、调试API。
  • 支持保存和管理测试用例。

4. 安全管理

• 认证与授权：
  • 支持常见的认证方式（API Key, OAuth 2.0, JWT等）。

5. 资源管理

• 统一资源：
  • 支持设置Header资源，可以设置项目或分组共用、单接口使用。

四、技术选型

项目使用 walis 进行开发。

Vue.js ：提供友好的用户界面。

Golang：处理业务逻辑和API请求。 在本项目中，仅承担界面渲染不参加具体的逻辑实现。