HackSoftware/Django-Styleguide
1
1
Fork 0
mirror of https://github.com/HackSoftware/Django-Styleguide.git synced 2025-02-12 01:20:51 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add naming convention for APIs

Browse Source
This commit is contained in:
Radoslav Georgiev 2019-11-30 12:44:37 +02:00
parent 8d3fb415de
commit dd6ffdd50d
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -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: `<Entity><Action>Api`.
Here are few examples: `UserCreateApi`, `UserSendResetPasswordApi`, `UserDeactivateApi`, etc.
### An example list API
```python