From dd6ffdd50dce484f56b7ab2f112699149df755e1 Mon Sep 17 00:00:00 2001 From: Radoslav Georgiev Date: Sat, 30 Nov 2019 12:44:37 +0200 Subject: [PATCH] Add naming convention for APIs --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index c0e772a..0b7faf9 100644 --- a/README.md +++ b/README.md @@ -363,6 +363,12 @@ General rules for an API is: * Reuse serializers as little as possible * If you need a nested serializer, use the `inline_serializer` util +### Naming convention + +For our APIs we use the following naming convention: `Api`. + +Here are few examples: `UserCreateApi`, `UserSendResetPasswordApi`, `UserDeactivateApi`, etc. + ### An example list API ```python