Skip to content

Porsche Development Guidance

API Design

Porsche Development Guidance

Home
Architecture
Architecture
- Porsche Architecture Goals
- Porsche Goals and Principles
  Porsche Goals and Principles
Assessments
Assessments
- Overview
- DevOps Maturity
Coding
Coding
- Core Principles
  Core Principles
- Version Controlling
  Version Controlling
- Rulesets
  Rulesets
  - Overview
  - Java Ruleset
- Instructions
  Instructions
- Processes
  Processes
- Security
  Security
API Guidelines
API Guidelines
- API Guidelines
- General Principles
  General Principles
- REST API Guidelines
  REST API Guidelines

API Design¶

Every API MUST be resouce-centric (Web API Design Maturity Model Level 2).

An API MUST provide its endpoints representing resources and expose the ability to work on those resources using intuitive HTTP Request Methods and sub-resources. See resource names.