Skip to content

Latest commit

 

History

History
149 lines (105 loc) · 7.91 KB

README.rst

File metadata and controls

149 lines (105 loc) · 7.91 KB

Objects API

Version: 2.4.3
Source:https://github.com/maykinmedia/objects-api
Keywords:objects, assets, zaakobjecten

Documentation Status

API to manage objects belonging to a certain object type. (Nederlandse versie)

Developed by Maykin Media B.V. commissioned by the Municipality of Utrecht.

Introduction

The Objects API aims to easily store various objects and make them available in standardized format. It can be used by any organization to manage relevant objects. An organization can also choose to use it to expose objects to the public as Open Data.

To define the format of objects, so called object types, organizations can use a national and/or local Objecttypes API.

API specification

Lint OAS Generate SDKs Generate Postman collection

Version Release date API specification
latest n/a ReDoc, Swagger, (diff)
2.4.3 2024-03-22 ReDoc, Swagger (diff)
2.3.0 2024-03-15 ReDoc, Swagger (diff)
2.2.1 2024-01-30 ReDoc, Swagger (diff)
2.1.1 2022-06-24 ReDoc, Swagger (diff)
2.1.0 2022-05-17 ReDoc, Swagger (diff)
2.0.0 2021-09-22 ReDoc, Swagger (diff)

Previous versions are supported for 6 month after the next version is released.

See: All versions and changes

Reference implementation

Build status Coverage Code style Docker image Supported Python version

The reference implementation is used to demonstrate the API in action and can be used for test and demo purposes. The reference implementation is open source, well tested and available as Docker image.

Quickstart

  1. Download and run the Objects API:

    wget https://raw.githubusercontent.com/maykinmedia/objects-api/master/docker-compose.yml
    docker compose up -d --no-build
    docker compose exec web src/manage.py loaddata demodata
    docker compose exec web src/manage.py createsuperuser
  2. In the browser, navigate to http://localhost:8000/ to access the admin and the API.

References

License

Copyright © Maykin Media, 2020 - 2021

Licensed under the EUPL