https://github.com/ithaka/apiron

:fried_egg: apiron is a Python package that helps you cook a tasty client for RESTful APIs. Just don't wash it with SOAP.
https://github.com/ithaka/apiron

api-client ithaka-owner-ui-engineering jstor-frontend microservices python python-package requests rest-client

Last synced: 7 months ago
JSON representation

:fried_egg: apiron is a Python package that helps you cook a tasty client for RESTful APIs. Just don't wash it with SOAP.

• Host: GitHub
• URL: https://github.com/ithaka/apiron
• Owner: ithaka
• License: mit
• Created: 2018-10-01T16:38:49.000Z (over 6 years ago)
• Default Branch: dev
• Last Pushed: 2024-10-28T14:16:53.000Z (7 months ago)
• Last Synced: 2024-10-28T17:19:02.396Z (7 months ago)
• Topics: api-client, ithaka-owner-ui-engineering, jstor-frontend, microservices, python, python-package, requests, rest-client
• Language: Python
• Homepage: https://apiron.readthedocs.io
• Size: 360 KB
• Stars: 122
• Watchers: 18
• Forks: 16
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# apiron

[![PyPI version](https://badge.fury.io/py/apiron.svg)](https://pypi.org/project/apiron/#history)

[![Supported Python versions](https://img.shields.io/pypi/pyversions/apiron.svg)](https://pypi.org/project/apiron/)

[![Build status](https://github.com/github/docs/actions/workflows/main.yml/badge.svg)](https://github.com/ithaka/apiron/actions)

[![Documentation Status](https://readthedocs.org/projects/apiron/badge/?version=latest)](https://apiron.readthedocs.io)

[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](code-of-conduct.md)

`apiron` helps you cook a tasty client for RESTful APIs. Just don't wash it with SOAP.



Gathering data from multiple services has become a ubiquitous task for web application developers.

The complexity can grow quickly:

calling an API endpoint with multiple parameter sets,

calling multiple API endpoints,

calling multiple endpoints in multiple APIs.

While the business logic can get hairy,

the code to interact with those APIs doesn't have to.

`apiron` provides declarative, structured configuration of services and endpoints

with a unified interface for interacting with them.

## Defining a service

A service definition requires a domain

and one or more endpoints with which to interact:

```python

from apiron import JsonEndpoint, Service

class GitHub(Service):

    domain = 'https://api.github.com'

    user = JsonEndpoint(path='/users/{username}')

    repo = JsonEndpoint(path='/repos/{org}/{repo}')

```

## Interacting with a service

Once your service definition is in place, you can interact with its endpoints:

```python

response = GitHub.user(username='defunkt')

# {"name": "Chris Wanstrath", ...}

response = GitHub.repo(org='github', repo='hub')

# {"description": "hub helps you win at git.", ...}

```

To learn more about building clients, head over to [the docs](https://apiron.readthedocs.io).

## Contributing

We are happy to consider contributions via pull request,

especially if they address an existing bug or vulnerability.

Please read our [contribution guidelines](./.github/CONTRIBUTING.md) before getting started.

## License

This package is available under the MIT license.

For more information, [view the full license and copyright notice](./LICENSE).

Copyright 2018-2022 Ithaka Harbors, Inc.