https://github.com/a6b8/upapi
This REST API connects the Lukso Blockchain to an AI system for processing and displaying Universal Profiles data. It also includes a Schema Generator following the OpenAI standard (Swagger) to describe the API.
https://github.com/a6b8/upapi
buildup cryptocurrency evm lukso lukso-blockchain
Last synced: 3 months ago
JSON representation
This REST API connects the Lukso Blockchain to an AI system for processing and displaying Universal Profiles data. It also includes a Schema Generator following the OpenAI standard (Swagger) to describe the API.
- Host: GitHub
- URL: https://github.com/a6b8/upapi
- Owner: a6b8
- License: apache-2.0
- Created: 2023-11-23T09:47:23.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-11-24T17:56:53.000Z (over 1 year ago)
- Last Synced: 2024-05-20T23:21:08.977Z (about 1 year ago)
- Topics: buildup, cryptocurrency, evm, lukso, lukso-blockchain
- Language: JavaScript
- Homepage: https://api.learnlukso.xyz
- Size: 235 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# UP API
This REST API retrieves data related to `Universal Profiles` from the `Lukso Blockchain` and serves as a bridge between the blockchain and an AI system that processes and presents the data in a suitable manner. Additionally, it includes a Schema Generator that describes the API according to the OpenAI standard (Swagger).
## Quickstart
### Run Server
```js
import { UpApi } from './src/UpApi.mjs'
const upApi = new UpApi()
upApi
.init( { 'environment': 'quickstart' } )
.start()
```
### Generate OpenAI Schema
```js
import { UpApi } from './src/UpApi.mjs'
const upApi = new UpApi()
const schema = upApi.getOpenAiSchema( {
'title': 'My Title',
'description': `My description`,
'version': 'v0.0.2',
'url': 'https://...'
} )
console.log( JSON.stringify( schema, null, 4 ) )
```
### Fetch Data
```sh
curl --location 'localhost:4040/getUniversalProfile?address=0xB031363560403179Aac100d51864e27fFF4D7807' \
--header 'x-api-key: ...'
```
## Table of Contents
- [UP API](#up-api)
- [Quickstart](#quickstart)
- [Run Server](#run-server)
- [Generate OpenAI Schema](#generate-openai-schema)
- [Fetch Data](#fetch-data)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Methods](#methods)
- [init( {} )](#init--)
- [start()](#start)
- [getOpenAISchema](#getopenaischema)
- [License](#license)
## Features
- Add Header Api Key through key `x-api-key`. To set secrets see `.init({})`
- OpenAI Schema generator, for Custom GPT integration.
- Add `/health` route
- Add `/privacy` route. You can find the template here: `./public/privacy.html`
## Methods
Public methods include init, start, and getOpenAISchema.
### init( {} )
The following key/value pairs are editable:
| Name | Description | Required | Default | Type |
|--------------|---------------------------------------------------|----------|----------------|------------------------------------------|
| environment | Is needed to locate the environment variables. For 'developement' it expect a file on `./.env`. For `staging` search in `process.env` | Yes | `development` | `string` [ 'development', 'staging' ] |
| version | The version number of the application | No | `` (empty string) | string |
For informations you can find under `./src/data/config.mjs`
**Returns**:
```js
return this
```
**Example**:
```js
import { UpApi } from './src/UpApi.mjs'
const upApi = new UpApi()
upApi
.init( { 'environment': 'quickstart', 'version': 'v0.2' } )
.start()
```
### start()
Start the server after settings via .init({}).
**Example**:
```js
import { UpApi } from './src/UpApi.mjs'
const upApi = new UpApi()
upApi
.init( { 'environment': 'quickstart', 'version': 'v0.2' } )
.start()
```
### getOpenAISchema
Generate an OpenAI Schema configuration file for Custom GPT integration.
```js
import { UpApi } from './src/UpApi.mjs'
const upApi = new UpApi()
const schema = upApi.getOpenAiSchema( {
'title': 'Title',
'description': `Description`,
'version': '',
'url': 'https://...'
} )
console.log( JSON.stringify( schema, null, 4 ) )
```
## License
This project is licensed under the [Apache 2.0](LICENSE).