https://github.com/or13/gnarly

Example VC API thats supports BBS+, VC-JWT and JsonWebSignature2020
https://github.com/or13/gnarly

Last synced: about 1 year ago
JSON representation

Example VC API thats supports BBS+, VC-JWT and JsonWebSignature2020

• Host: GitHub
• URL: https://github.com/or13/gnarly
• Owner: OR13
• License: apache-2.0
• Created: 2021-07-31T20:46:36.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-07-31T21:20:13.000Z (almost 5 years ago)
• Last Synced: 2025-03-16T22:11:39.855Z (about 1 year ago)
• Language: TypeScript
• Homepage: https://gnarly.or13.io
• Size: 914 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
### GNARYLY

[VC Data Model + OAS 3.0 + OAuth2](https://gnarly.or13.io)

This repo was created to as a proposal for changes to the VC-HTTP-API.

Main improvements over the current API:

1. Supports VC-JWT

1. Supports JsonWebSignature2020

1. Supports Authorization

1. Supports BBS+ Selective Disclosure Presentation Exchange

#### API Documentation

```

npm run build:docs

npm run serve:docs

```

Visit [http://localhost:5000](http://localhost:5000)

#### Setting Up Authorization

1. Create an API in Auth0

![create an api that supports scopes](./docs/auth0-create-api.png)

2. Create a Scopes in Auth0 from the OAS 3.0 Spec guidelines

![setup scopes](./docs/auth0-scopes.png)

3. Configure OAS 3.0 YAML to use Auth0

![use scopes from oas3](./docs/oas-permissions.png)

If you are interested in adding additional security schemes, checkout:

[OpenAPI Specification](https://swagger.io/specification/)

Funny how they don't seem to be listing GNAP or RAR there...

...almost like they are not mature enough to use yet.