apiGo

module
v0.0.0-...-c173c0e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 19, 2024 License: MIT

README

API Go with Gin

This repository contains a REST API implemented in Go using the Gin framework. The API follows a layered structure organized into repositories, services, and controllers (handlers), aiming to enhance scalability and maintainability of the codebase.

Features

  • Robust and reliable handlers tested extensively using libraries like Testify.
  • Thorough documentation of the API provided through Swagger, ensuring clear guidelines for usage and future development.
  • Majority of the codebase boasts test coverage exceeding 80%, guaranteeing high quality and reliability.

Getting Started

To get started with this API, follow these steps:

  1. Clone the repository:
    git clone https://github.com/davidop97/apiGo.git
    
  2. Install dependencies:
    go mod tidy
    
  3. Run the application:
    go run cmd/server/main.go
    

For more detailed instructions and API documentation, refer to the Swagger documentation provided.

Contribution

Contributions to this project are welcome! Feel free to open an issue or submit a pull request with any enhancements or bug fixes.

License

This project is licensed under the MIT License.

Directories

Path Synopsis
cmd
server command
Package docs Code generated by swaggo/swag.
Package docs Code generated by swaggo/swag.
internal
pkg
web

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL