69 lines
1.0 KiB
Markdown
69 lines
1.0 KiB
Markdown
# @coze-studio/api-schema
|
|
|
|
api scheme for open source
|
|
|
|
## Overview
|
|
|
|
This package is part of the Coze Studio monorepo and provides api & networking functionality. It serves as a core component in the Coze ecosystem.
|
|
|
|
## Getting Started
|
|
|
|
### Installation
|
|
|
|
Add this package to your `package.json`:
|
|
|
|
```json
|
|
{
|
|
"dependencies": {
|
|
"@coze-studio/api-schema": "workspace:*"
|
|
}
|
|
}
|
|
```
|
|
|
|
Then run:
|
|
|
|
```bash
|
|
rush update
|
|
```
|
|
|
|
### Usage
|
|
|
|
```typescript
|
|
import { /* exported functions/components */ } from '@coze-studio/api-schema';
|
|
|
|
// Example usage
|
|
// TODO: Add specific usage examples
|
|
```
|
|
|
|
## Features
|
|
|
|
- Core functionality for Coze Studio
|
|
- TypeScript support
|
|
- Modern ES modules
|
|
|
|
## API Reference
|
|
|
|
### Exports
|
|
|
|
- `* as passport`
|
|
|
|
|
|
For detailed API documentation, please refer to the TypeScript definitions.
|
|
|
|
## Development
|
|
|
|
This package is built with:
|
|
|
|
- TypeScript
|
|
- Modern JavaScript
|
|
- Vitest for testing
|
|
- ESLint for code quality
|
|
|
|
## Contributing
|
|
|
|
This package is part of the Coze Studio monorepo. Please follow the monorepo contribution guidelines.
|
|
|
|
## License
|
|
|
|
Apache-2.0
|