APISpider – Backend

The core API engine for APISpider, a lightweight, open-source collaborative API development and testing platform. Built with Go and Gin.

This repository contains the backend application for APISpider, a lightweight and developer-focused API client. You can also check out the sibling repositories:

APISpider frontend

APISpider agent

---

Tech Stack

• Language: Go (v1.22+)
• Web Framework: Gin Gonic
• ORM: GORM
• Database: PostgreSQL
• Auth: JWT (JSON Web Tokens)
• Validation: Gin binding (Validator v10)

---

Getting Started

Prerequisites

• Go 1.22 or higher
• PostgreSQL 14 or higher
• SMTP Server (Optional, for email features)

Installation & Setup

1. Clone the repository

   git clone https://github.com/your-username/apispider-backend.git
   cd apispider-backend

2. Configure Environment Variables Copy the example environment file and update it with your database credentials and secrets:

   cp .env.example .env

3. Install Dependencies

   go mod download

4. Run the Application The application will automatically perform database migrations on the first start.

   PORT=8081 SMTP_ENABLED=false go run main.go

Contributing

Contributions are welcome and appreciated

If you’d like to contribute:

1. Fork the repository
2. Create a new branch (git checkout -b feature/my-feature)
3. Make your changes
4. Commit your changes (git commit -m "Add my feature")
5. Push to the branch (git push origin feature/my-feature)
6. Open a Pull Request

Please try to:

• Follow the existing code style and project structure
• Keep commits focused and descriptive
• Test your changes before submitting

If you’re unsure where to start, feel free to open an issue or discussion.

---

Support the Project

If you find APISpider useful, consider supporting the project
Support on Ko-fi