# Overview

{% hint style="info" %}
**Documentation:** <https://docs.oxid-projects.com/oxid-rest-api/>\
**Repository:** <https://github.com/OXIDprojects/oxid-rest-api>
{% endhint %}

## About

This community project was started on the [OXID Hackathon 2018](https://openspacer.org/12-oxid-community/223-oxid-hackathon-nuernberg-2018/).\
It´s based on the PHP micro framework [Lumen](https://lumen.laravel.com/).

## Status quo

This project is wip (work in progress). The API is functionally working and the first route [*articles*](https://docs.oxid-projects.com/oxid-rest-api/routes-1/routes/articles#get-all-articles) exists.

{% content-ref url="contribution" %}
[contribution](https://docs.oxid-projects.com/oxid-rest-api/contribution)
{% endcontent-ref %}

{% content-ref url="changelog" %}
[changelog](https://docs.oxid-projects.com/oxid-rest-api/changelog)
{% endcontent-ref %}

## SwaggerLume Installation

* Run `php artisan swagger-lume:publish-config` to publish configs (`config/swagger-lume.php`)
* Make configuration changes if needed
* Run `php artisan swagger-lume:publish` to publish everything

## Configuration

* Run `php artisan swagger-lume:publish-config` to publish configs (`config/swagger-lume.php`)
* Run `php artisan swagger-lume:publish-views` to publish views (`resources/views/vendor/swagger-lume`)
* Run `php artisan swagger-lume:publish` to publish everything
* Run `php artisan swagger-lume:generate` to generate docs

## Credits

* Tobias Merkl | [@tabsl](https://twitter.com/tabsl) | [proudcommerce.com](https://www.proudcommerce.com)
* Stefan Moises | [@upsettweety](https://twitter.com/upsettweety) | [rent-a-hero.de](http://www.rent-a-hero.de)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.oxid-projects.com/oxid-rest-api/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.