Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/odisseu93/openai-api
back end for the OpenAi api
https://github.com/odisseu93/openai-api
back-end back-end-development backend backend-api express express-js expressjs nodejs open-source openai openai-api tests tyoescript typescript
Last synced: 22 days ago
JSON representation
back end for the OpenAi api
- Host: GitHub
- URL: https://github.com/odisseu93/openai-api
- Owner: Odisseu93
- Created: 2023-12-05T23:53:52.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-20T22:30:42.000Z (11 months ago)
- Last Synced: 2024-01-20T23:28:55.541Z (11 months ago)
- Topics: back-end, back-end-development, backend, backend-api, express, express-js, expressjs, nodejs, open-source, openai, openai-api, tests, tyoescript, typescript
- Language: TypeScript
- Homepage: https://openai-api-rho.vercel.app
- Size: 75.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Openai Api
```json
{
"message": "Welcome to OpenAi API!",
"repository": "https://github.com/Odisseu93/openai-api"
}
```
Back end criado para fazer integração com a API da [openai](https://openai.com/)
## Services disponíveis
- :pushpin: [Gerador de descrição de produtos](#product-description-generator)
## variáveis de ambiente
| nome | tipo |
| ---- | ---- |
| PORT | number |
| OPENAI_API_KEY | string |
## Rodar localmente
1. Clone este repositório em seu ambiente local:
```bash
git clone https://openai-api.git
```
---
2. Navegue até o diretório do projeto
```bash
cd openai-api
```
---
3. Instale as dependências
```bash
yarn install
```
---
4. Crie um arquivo `.env` na raiz do projeto e defina as variáveis de ambiente necessárias. Consulte a seção de [variáveis de ambiente](#variáveis-de-ambiente) para obter mais informações sobre as variáveis necessárias.
---
5. Rode o servidor localmente
```bash
yarn dev
```
---
---
## Gerador de descricao de produtos
https://github.com/Odisseu93/openai-api/assets/76600539/57716cf6-451c-4b93-a426-5b1d6ec5f68a
### Como usar :grey_question::
- endpoint
```
/generate/product-description
```
- tipo **POST**
- request body (parâmetros)
| nome | tipo |
| ---- | ---- |
| name | string |
| category | string |
| additionalInformation (opcional) | string |
### Reponses
- **200**
```json
{
"message": "Product description generated successfully!",
"description": "content..."
}
```
- **400**
```json
{
"message": "The name and category are required!",
}
```
- **500**
```json
{
"message": "Some unknown error...",
}
```
## Desenvolvedor/Autor
