OpenAPI / Swagger Viewer

Swagger Specification

openapi: 3.0.0
info:
  title: User Directory API
  description: A sample API to manage users, roles, and retrieve profile information.
  version: 1.0.0
servers:
  - url: https://api.userdirectory.com/v1
    description: Production Server
  - url: https://staging-api.userdirectory.com/v1
    description: Staging Server
paths:
  /users:
    get:
      summary: Retrieve a list of users
      description: Returns a paginated list of users. You can filter by role or status.
      tags:
        - Users
      parameters:
        - name: limit
          in: query
          description: Max number of users to return
          required: false
          schema:
            type: integer
            default: 10
            example: 20
        - name: role
          in: query
          description: Filter users by role
          required: false
          schema:
            type: string
            enum: [admin, member, guest]
            example: member
      responses:
        '200':
          description: Successful response returning list of users
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                    example: 120
                  users:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      summary: Create a new user
      description: Register a new user in the directory.
      tags:
        - Users
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserCreateInput'
      responses:
        '201':
          description: User created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '400':
          description: Bad request (validation failed)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /users/{id}:
    get:
      summary: Get user by ID
      description: Retrieve profile information for a specific user.
      tags:
        - Users
      parameters:
        - name: id
          in: path
          description: Unique identifier of the user
          required: true
          schema:
            type: string
            example: "usr_998822"
      responses:
        '200':
          description: Profile information retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: User not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      summary: Delete user
      description: Permanently delete a user from the directory.
      tags:
        - Users
      parameters:
        - name: id
          in: path
          description: Unique identifier of the user
          required: true
          schema:
            type: string
            example: "usr_998822"
      responses:
        '204':
          description: User deleted successfully
        '404':
          description: User not found
components:
  schemas:
    User:
      type: object
      required:
        - id
        - email
        - name
        - role
      properties:
        id:
          type: string
          description: Unique identifier of the user
          example: "usr_998822"
        email:
          type: string
          description: Email address of the user
          example: "john.doe@example.com"
        name:
          type: string
          description: Full name of the user
          example: "John Doe"
        role:
          type: string
          description: Access role of the user
          example: "member"
        createdAt:
          type: string
          description: Timestamp when the user was created
          example: "2026-06-11T09:44:43Z"
    UserCreateInput:
      type: object
      required:
        - email
        - name
      properties:
        email:
          type: string
          description: Email address for the new account
          example: "jane.smith@example.com"
        name:
          type: string
          description: Full name of the new user
          example: "Jane Smith"
        role:
          type: string
          description: Default role to assign
          default: "member"
          example: "member"
    ErrorResponse:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          example: "INVALID_REQUEST"
        message:
          type: string
          example: "The request body failed validation checks."

No API Spec Loaded

Paste a valid OpenAPI 3.0 configuration or load the example to get started.