PHPackages sioweb/oxid-api - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [HTTP & Networking](/categories/http) 4. / 5. sioweb/oxid-api ActiveOxidkernel-module[HTTP & Networking](/categories/http) sioweb/oxid-api =============== Symfony based api 0.4.2(5y ago)21.4k1GPL-3.0-onlyPHPPHP ^7.0 Since Mar 19Pushed 5y ago2 watchersCompare [ Source](https://github.com/Sioweb/OxidApi)[ Packagist](https://packagist.org/packages/sioweb/oxid-api)[ Docs](https://github.com/Sioweb/OxidApi)[ RSS](/packages/sioweb-oxid-api/feed)WikiDiscussions master Synced today READMEChangelog (10)Dependencies (3)Versions (33)Used By (0) Oxid 6 REST-Api auf Symfonybasis ================================ [](#oxid-6-rest-api-auf-symfonybasis) Vorwort ------- [](#vorwort) Diese API befindet sich im Aufbau, wenn ihr die API installiert, hat jeder Zugriff auf eure Artikel & Kategorien. Ich rate vom Live-Betrieb ab - auch wenn es funktionieren würde - bis eine Authentifizierung mit nem Secret Key oder HTTP-Password möglich ist Authentifizierung siehe weiter unten. Entwicklung, Forken ------------------- [](#entwicklung-forken) Dieses Projekt darf im Sinne von GNU LGPL 3+ geforkt, weiterentwickelt und verbreitet werden. Kostenlos. Um Parallelentwicklung zu vermeiden, wäre es allerdings von meiner Seite aus gut, wenn wir es in diesem Repo entwickeln. Feedbacks, Fragen, Hinweise nehme ich gerne entgegen. Installation ------------ [](#installation) ``` composer req sioweb/oxid-api ``` Nach der Installation, müssen die Module `Sioweb | Oxid Kernel` und `Sioweb | Oxid Symfony API` im Backend von Oxid aktiviert werden. Was zum? -------- [](#was-zum) Ja genau. Eine REST-API auf Symfony-Basis mit echten Routen die Informationen als JSON ausgibt. Authentifizierung ----------------- [](#authentifizierung) Alle Routen sind nun über HTTP-Authentifizierung benutzbar. Dazu einfach den Oxid Benutzernamen und Passwort angeben. Es fehlt nun noch, Routen einzeln zu schützen und ein Token-Login soll ebenfalls möglich werden. Routen ------ [](#routen) ### Folgende `Routes` liefern ergebnisse: [](#folgende-routes-liefern-ergebnisse) Curl in der Konsole nutzen: `curl -k -H "X-AUTH-TOKEN: THIS_IS_A_TOKEN" https://deine-url/api/v1/article/` #### Artikel [](#artikel) - \[GET\] - [https://deine-domain.tld/api/v1/article/{item}/](https://deine-domain.tld/api/v1/article/%7Bitem%7D/) \[GET\] #### Kategorien [](#kategorien) - \[GET\] - [https://deine-domain.tld/api/v1/category/{item}/](https://deine-domain.tld/api/v1/category/%7Bitem%7D/) \[GET\] ### Folgende `Routes` werden irgendwann funktionieren: [](#folgende-routes-werden-irgendwann-funktionieren) - \[POST\] - [https://deine-domain.tld/api/v1/article/{item}/](https://deine-domain.tld/api/v1/article/%7Bitem%7D/) \[PUT\] - [https://deine-domain.tld/api/v1/article/{item}/](https://deine-domain.tld/api/v1/article/%7Bitem%7D/) \[DELETE\] - \[POST\] - [https://deine-domain.tld/api/v1/category/{item}/](https://deine-domain.tld/api/v1/category/%7Bitem%7D/) \[PUT\] - [https://deine-domain.tld/api/v1/category/{item}/](https://deine-domain.tld/api/v1/category/%7Bitem%7D/) \[DELETE\] - \[GET\] - \[POST\] - [https://deine-domain.tld/api/v1/order/{item}/](https://deine-domain.tld/api/v1/order/%7Bitem%7D/) \[GET\] - [https://deine-domain.tld/api/v1/order/{item}/](https://deine-domain.tld/api/v1/order/%7Bitem%7D/) \[PUT\] - [https://deine-domain.tld/api/v1/order/{item}/](https://deine-domain.tld/api/v1/order/%7Bitem%7D/) \[DELETE\] - \[GET\] - \[POST\] - [https://deine-domain.tld/api/v1/user/{item}/](https://deine-domain.tld/api/v1/user/%7Bitem%7D/) \[GET\] - [https://deine-domain.tld/api/v1/user/{item}/](https://deine-domain.tld/api/v1/user/%7Bitem%7D/) \[PUT\] - [https://deine-domain.tld/api/v1/user/{item}/](https://deine-domain.tld/api/v1/user/%7Bitem%7D/) \[DELETE\] - [https://deine-domain.tld/api/v1/{\_url\_fragment}](https://deine-domain.tld/api/v1/%7B_url_fragment%7D) Warum nicht GraphQL? -------------------- [](#warum-nicht-graphql) Es gibt keinen Grund. Ich denke GraphQL ist sicher flexibler und besser - warum ein starres REST-Model wenn auch eine Querylanguage geht. Ich bin REST-Apis gewohnt und habe nur durch etwas Angular in verbindung mit MongoDB usw. Erfahrung mit GQL gesammelt. ### Health Score 29 — LowBetter than 60% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity18 Limited adoption so far Community9 Small or concentrated contributor base Maturity56 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~15 days Recently: every ~78 days Total 31 Last Release 2156d ago PHP version history (2 changes)0.0.1PHP >=7.0 0.4.0PHP ^7.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/7d49da0a686ca7562a86685d3216627abc5ce59362e6c2914c9b323f2b888aa8?d=identicon)[Sioweb](/maintainers/Sioweb) --- Top Contributors [![Sioweb](https://avatars.githubusercontent.com/u/1318048?v=4)](https://github.com/Sioweb "Sioweb (22 commits)") --- Tags oxid6rest-apiapirestOXIDmodules ### Embed Badge ![Health badge](/badges/sioweb-oxid-api/health.svg) ``` [![Health](https://phpackages.com/badges/sioweb-oxid-api/health.svg)](https://phpackages.com/packages/sioweb-oxid-api) ``` ### Alternatives [lexik/jwt-authentication-bundle This bundle provides JWT authentication for your Symfony REST API 2.6k58.7M210](/packages/lexik-jwt-authentication-bundle)[angelleye/paypal-php-library PHP wrapper for PayPal APIs 243440.9k](/packages/angelleye-paypal-php-library)[lafourchette/switch-user-stateless-bundle Bundle to use impersonating on Symfony API 3896.2k](/packages/lafourchette-switch-user-stateless-bundle)[phrest/api REST API Package for Phalcon PHP 304.2k](/packages/phrest-api) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)