https://github.com/codeliner/httpapidoc

https://github.com/codeliner/httpapidoc

Last synced: 5 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/codeliner/httpapidoc
• Owner: codeliner
• License: gpl-2.0
• Created: 2015-05-26T18:14:04.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-05-26T18:16:41.000Z (about 11 years ago)
• Last Synced: 2025-04-05T10:43:06.727Z (about 1 year ago)
• Size: 88.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# HTTPApiDoc

HTTPApiDoc aims to create a standard for documenting HTTP based APIs of almost any complexity.

However it is the position of this project, that limitless power is a dangerous thing for developers and API designers. Correspondingly, some things will be deliberately not taken into this standard. If you feel like some possibilities are missing please feel free to create an issue or provide a pull request to enhance this standard.

This standard will organically grow and will be released in versions that aim for targets.

The project will aim to create the standard as an XML, as XML can document structures and meta information in a tree form and the structure may not be polluted through it.

# Version Targets

## Version 1.0

**Status**: work in progress

**Additions**

- Type and structure documentation

- Structured strings

  - Query String format

  - JSON format

- Entry Points

  - Request format

    - URL

      - Protocol

      - User

      - Password

      - Host

      - Port

      - url-path (including dynamic elements)

      - Query

    - Headers

    - Body

  - Response format

    - Headers

      - Simplified http status notation

    - Body

- Common behaviour of all entry points

  - Common response

  - Common header