Libraries tagged by openapi documentation
ironcurtaindev/easy-doc
62 Downloads
A lightweight Laravel package for API documentation generation with PHP 8 Attributes support and configurable headers
imjarek/laravel-swagger
1310 Downloads
OpenApi or Swagger integration to Laravel
idrinth/phalcon-routes2openapi
46 Downloads
Generates an JSON represantation of the routes registered via phalcon in an OpenAPI-compatible way.
ibecsystems/admin-kit-scramble
885 Downloads
Automatic generation of API documentation for Laravel applications.
iamaeron/scramble-ui
20 Downloads
A custom dark UI theme for dedoc/scramble.
giahojnost/lumen-swagger
28 Downloads
OpenApi or Swagger integration to Lumen, Retouched based on DarkaOnLine/SwaggerLume
fxmonster/l5-swagger
14 Downloads
OpenApi or Swagger integration to Laravel
fwrepae/fwrepae
0 Downloads
The Inter TT REST API is described using OpenAPI 3.0. The descriptor for the api can be downloaded in both [YAML](http://localhost:8080/cyclos/api/openapi.yaml) or [JSON](http://localhost:8080/cyclos/api/openapi.json) formats. These files can be used in tools that support the OpenAPI specification, such as the [OpenAPI Generator](https://openapi-generator.tech). In the API, whenever some data is referenced, for example, a group, or payment type, either id or internal name can be used. When an user is to be referenced, the special word 'self' (sans quotes) always refers to the currently authenticated user, and any identification method (login name, e-mail, mobile phone, account number or custom field) that can be used on keywords search (as configured in the products) can also be used to identify users. Some specific data types have other identification fields, like accounts can have a number and payments can have a transaction number. This all depends on the current configuration. ----------- Most of the operations that return data allow selecting which fields to include in the response. This is useful to avoid calculating data that finally won't be needed and also for reducing the transfer over the network. If nothing is set, all object fields are returned. Fields are handled in 3 modes. Given an example object `{"a": {"x": 1, "y": 2, "z": 3}, "b": 0}`, the modes are: - **Include**: the field is unprefixed or prefixed with `+`. All fields which are not explicitly included are excluded from the result. Examples: - `["a"]` results in `{"a": {"x": 1, "y": 2, "z": 3}}` - `["+b"]` results in `{"b": 0}` - `["a.x"]` results in `{"a": {"x": 1}}`. This is a nested include. At root level, includes only `a` then, on `a`'s level, includes only `x`. - **Exclude**: the field is prefixed by `-` (or, for compatibility purposes, `!`). Only explicitly excluded fields are excluded from the result. Examples: - `["-a"]` results in `{"b": 0}` - `["-b"]` results in `{"a": {"x": 1, "y": 2, "z": 3}}` - `["a.-x"]` results in `{"a": {"y": 2, "z": 3}}`. In this example, `a` is actually an include at the root level, hence, excludes `b`. - **Nested only**: when a field is prefixed by `*` and has a nested path, it only affects includes / excludes for the nested fields, without affecting the current level. Only nested fields are configured. Examples: - `["*a.x"]` results in `{"a": {"x": 1}, "b": 0}`. In this example, `a` is configured to include only `x`. `b` is also included because, there is no explicit includes at root level. - `["*a.-x"]` results in `{"a": {"y": 2, "z": 3}, "b": 0}`. In this example, `a` is configured to exclude only `x`. `b` is also included because there is no explicit includes at the root level. For backwards compatibility, this can also be expressed in a special syntax `-a.x`. Also, keep in mind that `-x.y.z` is equivalent to `*x.*y.-z`. You cannot have the same field included and excluded at the same time - a HTTP `422` status will be returned. Also, when mixing nested excludes with explicit includes or excludes, the nested exclude will be ignored. For example, using `["*a.x", "a.y"]` will ignore the `*a.x` definition, resulting in `{"a": {"y": 2}}`. ----------- For details of the deprecated elements (operations and model) please visit the [deprecation notes page](https://documentation.cyclos.org/4.16.3/api-deprecation.html) for this version.
fpeposhi/lusen
49 Downloads
Fast, SEO- and AI-agent-friendly API documentation for Laravel applications.
firdaushatta/l5-swagger
156 Downloads
OpenApi or Swagger integration to Laravel
faysal/riven
3 Downloads
API docs, a request playground and load tests for Laravel, generated from your routes, FormRequest rules and API Resources.
etkinlik/php-sdk
0 Downloads
API for integrating with event content aggregated and categorized from many sources and organizers. Use this documentation to build applications on top of Etkinlik.io event data.
esandri/swagger-ui-big
73 Downloads
Swagger UI is a collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.
eng-mmustafa/canopy
52 Downloads
Beautiful, hierarchical API documentation for Laravel. A branded, nested endpoint explorer powered by Scramble.
elmo-software/user-api-sdk
1 Downloads
# Overview The ELMO API is a RESTful based API that facilitates user information management within the ELMO ecosystem. Our API is designed to empower businesses, including our valued customers and partners, in creating scalable integration solutions aligned with their evolving business needs. By using this API, you gain access to invaluable HR data, enabling you to supercharge your applications and integrations, driving efficient workflows and enhancing core business processes. The below section provides an overview of the current capabilities of the API: * Get users list * Get an individual user's details * Get a user template to create a new user * Create new user * Get positions list * Get locations list * Get department list * Get metadata of configurable fields * Get all users employment details * Get an individual user's employment details * Get legal entity details * Get payroll calendar details * Get leave request details * Get leave type details Note that this is the latest version of the API Documentation that utilises OAuth2 authentication. The previous version of the documentation can be found at [API Documentation version 1](/v1/index.html) Please be advised that endpoints labelled as beta are intended for customer testing and feedback and may change based on feedback, potentially impacting backward compatibility. Consider this before integrating it with production systems to avoid disruptions to your integrations. --- # Authentication ELMO API utlises OAuth2.0 authentication. Company Admins are able to create and manage API Credentials. --- # API Rate Limits There are limits applied to the number of API requests your application can make. This limit is lower in sandbox and higher in production environments. The ELMO User API also supports custom usage plans to scale with your organisation's needs. Sandbox Environment * **Rate limit**: 1 request per second * **Burst limit**: 10 * **Quota**: 500 requests in 1 day Production Environment * **Rate limit**: 1 requests per second * **Burst limit**: 10 * **Quota**: 5000 requests in 1 day --- # Generating Client SDKs You can use the OpenAPI Specification file to generate a client SDK. You can download the file from [here](index.yaml). Then use the tool of your choice to generate a client SDK. You can get started [here](https://swagger.io/tools/swagger-codegen/).