[WIP] (feat) Add API tool (from bee-api) #132
Conversation
Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
Signed-off-by: Nigel Jones <jonesn@uk.ibm.com>
There was a problem hiding this comment.
Rename class to OpenAPI and place it in src/tools/openapi.ts.
| import { SchemaObject } from 'ajv'; | ||
| import { parse } from 'yaml'; | ||
| import { isEmpty } from 'remeda'; | ||
| import axios from 'axios'; |
There was a problem hiding this comment.
Don't use axios, use standard fetch.
|
|
||
| import { BaseToolOptions, StringToolOutput, Tool, ToolError } from '@/tools/base.js'; | ||
| import { SchemaObject } from 'ajv'; | ||
| import { parse } from 'yaml'; |
There was a problem hiding this comment.
yaml package must be added to peerDependencies
| import { HttpProxyAgent } from 'http-proxy-agent'; | ||
| import { HttpsProxyAgent } from 'https-proxy-agent'; |
There was a problem hiding this comment.
both packages must be added to peerDependencies
| name: string; | ||
| description: string; | ||
| openApiSchema: any; | ||
| apiKey?: string; |
| url: url.toString(), | ||
| data: !isEmpty(input.body) ? input.body : undefined, | ||
| method: input.method.toLowerCase(), | ||
| headers, |
| } | ||
| } | ||
|
|
||
| protected async _run(input: any) { |
There was a problem hiding this comment.
I would try to use protected async _run(input: SchemaObject) { instead of the any type.
| if (!this.openApiSchema?.paths) { | ||
| throw new ToolError("Server is not specified!") | ||
| } |
There was a problem hiding this comment.
Use ValueError instead of ToolError in constructor.
| if (this.apiKey) { | ||
| //TODO: #105 confirm ok to remove use of encrypted api key | ||
| headers['Authorization'] = `Bearer ${this.apiKey}`; | ||
| } |
There was a problem hiding this comment.
I would consider refactoring the whole URL building part by leveraging createURLParams function from src/internals/fetcher.ts module.
| }); | ||
| return new StringToolOutput(response.data); | ||
| } catch (error) { | ||
| throw new ToolError(`Request to ${url} failed.`); |
There was a problem hiding this comment.
Update to
throw new ToolError(`Request to ${url} failed.`, [error]);
|
Hello, @planetf1. Are you willing to continue on this? |
|
Closing for inactivity. |
Which issue(s) does this pull-request address?
Ref: #105
Description
Implements support for calling an API. Originally part of bee-api, this has now been moved into the framework as a tool.
An openAPI spec of the endpoint is required
Test support is included
NOTE This is still work in progress - opening up as a draft. Feedback welcome. Would like to check if this is the kind of thing you are looking for.
Lint/formatting checks are needed, along with additional tests within the yarn test:e2e framework, as well as validation the tool can be used more generally with bee.
I also need to identify a 'proper' rest endpoint to test against - either external, or by implementing a simple server within the test framework.
There are also TODOs and commented lines still left in the code. These will be resolved before moving PR out of draft
Checklist
yarn lintoryarn lint:fixyarn formatoryarn format:fixyarn test:unityarn test:e2e