Apache HttpComponents Requests API

HTTP request execution operations

OpenAPI Specification

apache-http-requests-api-openapi.yml Raw ↑
openapi: 3.0.3
info:
  title: Apache HttpComponents Client Configuration Requests API
  version: 5.3.0
  description: Reference API specification for Apache HttpComponents HTTP client library, covering request execution, connection management, authentication, and proxy configuration.
  contact:
    email: dev@hc.apache.org
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://api.example.com
  description: Example target server for HttpComponents client
tags:
- name: Requests
  description: HTTP request execution operations
paths:
  /execute:
    post:
      operationId: executeRequest
      summary: Apache HttpComponents Execute Request
      description: Execute an HTTP request using the Apache HttpComponents client with the provided request configuration.
      tags:
      - Requests
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/HttpRequest'
      responses:
        '200':
          description: Request executed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HttpResponse'
components:
  schemas:
    HttpResponse:
      type: object
      description: HTTP response from Apache HttpComponents client execution
      properties:
        statusCode:
          type: integer
          description: HTTP response status code
          example: 200
        reasonPhrase:
          type: string
          description: HTTP reason phrase
          example: OK
        headers:
          type: object
          description: Response headers as key-value pairs
          example:
            Content-Type: application/json
        body:
          type: string
          description: Response body content
          example: '{"result": "ok"}'
        contentType:
          type: string
          description: Content-Type of the response body
          example: application/json
    HttpRequest:
      type: object
      description: HTTP request configuration for Apache HttpComponents client
      properties:
        method:
          type: string
          description: HTTP method
          example: GET
        uri:
          type: string
          description: Request URI
          example: https://api.example.com/data
        headers:
          type: object
          description: Request headers as key-value pairs
          example:
            Accept: application/json
            Authorization: Bearer token
        body:
          type: string
          description: Request body content
          example: '{"key": "value"}'
        contentType:
          type: string
          description: Content-Type header value
          example: application/json