Skip to content

tmnts/me-first-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 

Repository files navigation

🇯🇲 Me-First-API (Go + Gin)

Простой REST-микросервис для управления списком собак и проверки статуса API. Написан на ямайском желании разобраться в эндпойнтах.

🛠 Технологии

  • Language: Go 1.2x
  • Framework: Gin-Gonic
  • Testing: Thunder Client / Postman / cURL

🚀 Быстрый запуск

  1. Установите зависимости: go mod tidy
  2. Запустите сервер: go run main.go
  3. API будет доступно по адресу: http://localhost:8080

📡 Эндпойнты (Endpoints)

1. Welcome Route

GET / — Проверка работоспособности (Healthcheck). Возвращает ямайский вайб.

2. Get Hello

GET /hello — Базовый ответ сервера.

3. Get Dog by Name

GET /dog/:name — Возвращает статус конкретной собаки (с пасхалкой в виде HOODRICH).

  • Example: /dog/sharik

4. Add New Dawg

POST /dog — Добавление новой собаки в пак.

  • Body (JSON):
{
  "name": "БАРБОС",
  "breed": "БАНХАР"
}

☢️ Ответы от API

Success Response (201 Created): Вы теперь ямайский пакман.

Error Response (400 Bad Request): Данила Багров скажет вам базу при кривом JSON.

🧛 Как отличить GET от POST при помощи cURL

GET 404 ERROR (404-АЯ ОШИБКА)

curl http://localhost:8080/

GET HELLO (БАЗОВЫЙ ОТВЕТ СЕРВЕРА)

curl http://localhost:8080/hello

GET DOG DATA (ГЕТ ПРО СОБАЧЕК)

curl http://localhost:8080/dog/sharik

POST A NEW DOG (ОТПРАВИТЬ ДАННЫЕ В ФОРМАТЕ JSON)

curl -X POST http://localhost:8080/dog \
     -H "Content-Type: application/json" \
     -d '{"name": "БАРБОС", "breed": "БАНХАР"}'

📊 Архитектура (Mermaid)

graph LR
    User((User/Client)) -->|Request| Gin[Gin Router]
    Gin -->|JSON| User
    subgraph Logic
    Gin --> GET[Read Data]
    Gin --> POST[Bind & Validate JSON]
    end
Loading

About

Simple REST API for dog-shop. С цитатами из "Брата 2".

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages