Skip to content

Commit

Permalink
Merge pull request #111 from hsoberon/feature/improve-documentation-v…
Browse files Browse the repository at this point in the history
…ersioning

Versioning documentation
  • Loading branch information
skie authored Nov 22, 2024
2 parents fbc72b0 + 281df6c commit 4e1b7d8
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions docs/Documentation/versioning.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Versioning


The cakephp-api supports versioning which allows for better management of features or plugins compatibility.

Cakephp-api use URL versioning. With a default semantic style like v1, v2, v3

**With versioning:** _www.example.com/api/**v2**/users_

**Without versioning:** *www.example.com/api/users*



## Enable versioning:

To enable it, you just need to turn true the configuration in the `config/api.php`

```'useVersioning' => true,```

### Testing

If you want to use versioingn on testing. Enable it in the `test/Config/api.php`

```'useVersioning' => true,```




0 comments on commit 4e1b7d8

Please sign in to comment.