Contents Menu Expand Light mode Dark mode Auto light/dark mode
OCP Software Development Handbook documentation
OCP Software Development Handbook documentation
  • General
    • Documentation
    • Preferences
    • Code
    • API
  • Python
    • Directory layout
    • Requirements
    • Preferred packages
    • Linting
    • Testing
    • Continuous integration
    • Documentation
    • Configuration
    • Logging
    • Django
    • File formats
    • General style
    • Internationalization (i18n)
    • Packages
    • Performance
  • Rust
  • JavaScript
  • Shell script
  • SQL
  • HTML and CSS
  • Docker
    • .dockerignore
    • Dockerfile
    • Dockerfile for Django
    • Continuous integration
  • Services
    • PostgreSQL
    • RabbitMQ
    • Administrative access
  • Git
  • GitHub
    • For developers
    • For users
    • For maintainers
    • For standards
    • Reference
  • Roadmap
  • Contributing
  v: latest
Versions
latest
Downloads
On Read the Docs
Project Home
Builds
Back to top
Edit this page

API#

Follow best practices for authoring APIs. Some tips:

  • Use status codes. Do not return JSON responses like {"status": "ok", "data": {...}}. See Choosing an HTTP Status Code — Stop Making It Hard.

Next
Python
Previous
Code
Copyright © 2020, Open Contracting Partnership
Made with Sphinx and @pradyunsg's Furo