Skip to content

Commit

Permalink
Merge pull request #1738 from boschresearch/feature/open-api-client-doc
Browse files Browse the repository at this point in the history
Documentation on existing language wrappers for aca-py
  • Loading branch information
swcurran authored Apr 27, 2022
2 parents 0c695cf + 42c6e19 commit 61f8734
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions UsingOpenAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,22 @@ Two major open source code generation tools are [Swagger](https://github.com/swa

Another suggestion for code generation is to keep the `modelPropertyNaming` set to `original` when generating code. Although it is tempting to try and enable marshalling into standard naming formats such as `camelCase`, the reality is that the models represent what is sent on the wire and documented in the [Aries Protocol RFCS](https://github.com/hyperledger/aries-rfcs/tree/master/features). It has proven handy to be able to see code references correspond directly with protocol RFCs when debugging. It will also correspond directly with what the `model` shows when looking at the ACA-py `Swagger UI` in a browser if you need to try something out manually before coding. One final point is that on occasions it has been discovered that the code generation tools don't always get the marshalling correct in all circumstances when changing model name format.

## Existing Language Wrappers for ACA-py

### Python

- https://pypi.org/project/aries-cloudcontroller/
- https://github.com/didx-xyz/aries-cloudcontroller-python
- https://github.com/bcgov/traction/tree/develop/services/traction/acapy_client
- https://github.com/Indicio-tech/acapy-client

### Go

- https://github.com/ldej/go-acapy-client

### Java

- https://github.com/hyperledger-labs/acapy-java-client



Expand Down

0 comments on commit 61f8734

Please sign in to comment.