Как расшифровывается API

Расшифровка API

API расшифровывается как Application Programming Interface — интерфейс программирования приложений.

Что это значит

API — это набор правил и протоколов, которые позволяют разным программам взаимодействовать друг с другом. Это контракт между клиентом и сервером, который определяет, как они могут общаться.

// Пример: REST API endpoint
GET /api/v1/users/123
Response: {"id": 123, "name": "John", "email": "john@example.com"}

Компоненты расшифровки

• Application — приложение или сервис
• Programming — программирование, написание кода
• Interface — интерфейс, граница взаимодействия

Типы API

REST API — самый распространённый тип:

// GET запрос
GET /api/users          // Получить всех пользователей
GET /api/users/1        // Получить пользователя с id=1

// POST запрос
POST /api/users         // Создать нового пользователя

// PUT запрос
PUT /api/users/1        // Обновить пользователя

// DELETE запрос
DELETE /api/users/1     // Удалить пользователя

SOAP API — более сложный, основан на XML:

<?xml version="1.0"?>
<soap:Envelope>
  <soap:Body>
    <GetUser>
      <id>123</id>
    </GetUser>
  </soap:Body>
</soap:Envelope>

GraphQL API — новый подход для запроса данных:

query {
  user(id: 123) {
    name
    email
  }
}

Пример использования API в Java

import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class ApiExample {
    public static void main(String[] args) throws Exception {
        HttpClient client = HttpClient.newHttpClient();
        
        // GET запрос
        HttpRequest request = HttpRequest.newBuilder()
            .uri(new URI("https://api.example.com/users/1"))
            .GET()
            .build();
        
        HttpResponse<String> response = client.send(request, 
            HttpResponse.BodyHandlers.ofString());
        
        System.out.println("Status: " + response.statusCode());
        System.out.println("Body: " + response.body());
    }
}

HTTP коды ответов API

// 2xx — успех
200 OK                  // Запрос выполнен успешно
201 Created             // Ресурс создан
204 No Content          // Успешно, но нет содержимого

// 4xx — ошибка клиента
400 Bad Request         // Неправильный запрос
401 Unauthorized        // Требуется авторизация
403 Forbidden           // Доступ запрещён
404 Not Found           // Ресурс не найден

// 5xx — ошибка сервера
500 Internal Server Error  // Внутренняя ошибка
503 Service Unavailable    // Сервис недоступен

API в контексте Java приложения

@RestController
@RequestMapping("/api/users")
public class UserController {
    
    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        // API метод для получения пользователя
        return userService.findById(id);
    }
    
    @PostMapping
    public User createUser(@RequestBody User user) {
        // API метод для создания пользователя
        return userService.save(user);
    }
}

Зачем нужен API

1. Интеграция — разные системы могут взаимодействовать
2. Переиспользование — код можно использовать в разных проектах
3. Масштабируемость — легче добавлять новые функции
4. Безопасность — контролируемый доступ к ресурсам
5. Стандартизация — определённые правила и протоколы

Итоги

• API = Application Programming Interface
• Это интерфейс для взаимодействия приложений
• REST — самый популярный стиль API
• HTTP методы: GET, POST, PUT, DELETE
• HTTP коды указывают результат запроса
• API используется для интеграции и масштабирования приложений