https://github.com/samk13/invenio-api-toolkit

https://github.com/samk13/invenio-api-toolkit

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/samk13/invenio-api-toolkit
• Owner: Samk13
• License: mit
• Created: 2024-06-06T00:28:37.000Z (7 months ago)
• Default Branch: master
• Last Pushed: 2024-06-26T06:35:00.000Z (6 months ago)
• Last Synced: 2024-06-26T07:47:55.708Z (6 months ago)
• Size: 79.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Invenio API Toolkit

This repository contains tools to help you integrate use, test and document Invenio API.

You can import the collections in tools like Swagger UI, Postman, Bruno etc.

This definitions are generated from Postman collections, Bruno.

last updated: Invenio V11

## Postman Collection

The Postman collection is available in the `postman_collection` directory.

the recommended way to use the Postman collection is to import it into Postman.

> Check each request script tab for any magic assignments or environment variables.

> e.g. when you create a new community, the community id variable will be assigned to the environment variable `community_id` etc.

## Bruno collection

We have also created a collection for bruno, which is a another tool that has no cloud support tool to test the Invenio API.

The collection is available in the `bruno_collection` directory.

TODO: create scripts to fill the environment variables in the collection like the Postman collection.

## OpenAPI Definitions

To generate OpenAPI definitions, convert the Postman collection to OpenAPI 3.0.0 using the postman2openapi tool. This provides both the Postman collection and the OpenAPI definitions.

using [postman2openapi](https://github.com/kevinswiber/postman2openapi)

```bash

postman2openapi collection.json > openapi.yaml

```

functional but not complete yet.

TODO:

- [ ] add the new API endpoints introduced in V12

- [ ] add the error responses

- [ ] add schema definitions