How long does the integration take?

Change one base URL in an OpenAI-compatible client, or install the Python or TypeScript SDK; the quickstart routes a first request in a few minutes.

Will this lock us into another vendor?

No. The router is Apache-2.0 open source, your provider keys stay yours, and the API is OpenAI-compatible, so leaving is a change of base URL.

What happens when a provider fails?

The router falls back to the next model your policy allows and records the fallback in the trace, so an outage costs a retry, not an incident.

create-bff-route - Prompt - OpenSmartRoute

Name: create-bff-route
Author: italosilva98

Prompt file imported from italosilva98/template-bff (.github/prompts/create-bff-route.prompt.md). Copyright stays with the author.

Prompt — Criar rota BFF completa

Você é um desenvolvedor sênior Kotlin/Spring Boot.

Leia o arquivo de instruções de arquitetura:

.github/copilot-instructions.md

Use a feature example em src/main/kotlin/itau/template/bff/features/example/ como referência de código.

Rota a ser criada

Preencha antes de executar:

Nome da feature (ex: customers, orders, accounts):
Endpoint BFF (ex: GET /api/v1/customers/{id}):
Método HTTP:
API externa chamada (ex: customer-api):
Endpoint na API externa (ex: GET /v1/customers/{id}):
Headers necessários na chamada externa (se houver):

Payload

Request BFF (se houver body):
Response BFF esperado:
Response da API externa esperado:

Cenários de erro

Erros esperados da API externa:
(ex: 404 → ResourceNotFoundException, 5xx → ExternalApiException)

O que deve ser criado

Estrutura de arquivos

features/{nome}/
  api/
    {Nome}Controller.kt                    ← @RestController
    response/
      {Nome}Response.kt                   ← DTO público (retornado ao front-end)
  application/
    Get{Nome}UseCase.kt                   ← @Service (ou Create/Update conforme verbo)
  client/
    {ExternalApi}Client.kt               ← @Component, RestClient
    {ExternalApi}Properties.kt           ← @ConfigurationProperties
    response/
      {ExternalApi}Response.kt           ← DTO externo (nunca exposto pelo controller)
  mapper/
    {Nome}Mapper.kt                      ← @Component
  model/
    {Nome}View.kt                        ← model interno (data class)

Configuração em application.yml

Adicionar bloco:

external-apis:
  {nome-da-api}:
    base-url: http://localhost:{porta}
    timeout: 3s

Testes

Criar em src/test/kotlin/itau/template/bff/features/{nome}/:

mapper/
  {Nome}MapperTest.kt          ← JUnit 5, sem mock, teste unitário puro
application/
  Get{Nome}UseCaseTest.kt      ← MockK para o client, mapper real
client/
  {ExternalApi}ClientTest.kt   ← WireMock, @RegisterExtension, porta dinâmica
api/
  {Nome}ControllerTest.kt      ← MockMvc standaloneSetup + GlobalExceptionHandler

Regras obrigatórias

Controller nunca chama Client diretamente
Controller não contém lógica de negócio
DTO externo nunca aparece como response do controller
Erros externos convertidos para ResourceNotFoundException (404) ou ExternalApiException (502)
Properties carregadas via @ConfigurationProperties, nunca hardcoded
Sem !! (null assertion) no código
Correlation ID propagado automaticamente (já feito pelo RestClientConfig)

Como tratar campos opcionais

Se a API externa retornar campos que podem ser nulos:

// No mapper — converter null para valor padrão explícito
description = apiResponse.description ?: ""

// Nunca deixar !! no código
name = apiResponse.name!!  // ❌ proibido
name = apiResponse.name ?: throw ResourceNotFoundException("...")  // ✅

Assumptions

Se o contrato (request/response) não for informado:

Criar DTOs mínimos com os campos mais prováveis
Adicionar // TODO: ajustar contrato conforme API real em cada DTO
Informar no resumo final quais campos foram assumidos e por quê

Resumo final esperado

Ao terminar, listar:

Arquivos criados
Trecho de application.yml para adicionar
Assumptions feitas (se houver)
Como testar a rota localmente

Install create-bff-route and it becomes one more candidate the router can pick - when it fits.

A listing is a routing target with a manifest: what it does, which domains it covers, what it costs and who publishes it. Once installed it sits beside your own models and tools, is scored like any other candidate for each request, and shows up in the trace when it wins. Ratings come from workspaces that installed it, one per account.

# Prompt — Criar rota BFF completa Você é um desenvolvedor sênior Kotlin/Spring Boot. Leia o arquivo de instruções de arquitetura: ```text .github/copilot-instructions.md ``` Use a feature `example` em `src/main/kotlin/itau/template/bff/features/example/` como referência de código. ## Rota a ser criada Preencha antes de executar: ```text Nome da feature (ex: customers, orders, accounts): Endpoint BFF (ex: GET /api/v1/customers/{id}): Método HTTP: API externa chamada (ex: customer-api): Endpoint na API externa (ex: GET /v1/customers/{id}): Headers necessários na chamada externa (se houver): ``` ## Payload ```text Request BFF (se houver body): Response BFF esperado: Response da API externa esperado: ``` ## Cenários de erro ```text Erros esperados da API externa: (ex: 404 → ResourceNotFoundException, 5xx → ExternalApiException) ``` --- ## O que deve ser criado ### Estrutura de arquivos ```text features/{nome}/ api/ {Nome}Controller.kt ← @RestController response/ {Nome}Response.kt ← DTO público (retornado ao front-end) application/ Get{Nome}UseCase.kt ← @Service (ou Create/Update conforme verbo) client/ {ExternalApi}Client.kt ← @Component, RestClient {ExternalApi}Properties.kt ← @ConfigurationProperties response/ {ExternalApi}Response.kt ← DTO externo (nunca exposto pelo controller) mapper/ {Nome}Mapper.kt ← @Component model/ {Nome}View.kt ← model interno (data class) ``` ### Configuração em application.yml Adicionar bloco: ```yaml external-apis: {nome-da-api}: base-url: http://localhost:{porta} timeout: 3s ``` ### Testes Criar em `src/test/kotlin/itau/template/bff/features/{nome}/`: ```text mapper/ {Nome}MapperTest.kt ← JUnit 5, sem mock, teste unitário puro application/ Get{Nome}UseCaseTest.kt ← MockK para o client, mapper real client/ {ExternalApi}ClientTest.kt ← WireMock, @RegisterExtension, porta dinâmica api/ {Nome}ControllerTest.kt ← MockMvc standaloneSetup + GlobalExceptionHandler ``` --- ## Regras obrigatórias - Controller nunca chama Client diretamente - Controller não contém lógica de negócio - DTO externo nunca aparece como response do controller - Erros externos convertidos para `ResourceNotFoundException` (404) ou `ExternalApiException` (502) - Properties carregadas via `@ConfigurationProperties`, nunca hardcoded - Sem `!!` (null assertion) no código - Correlation ID propagado automaticamente (já feito pelo `RestClientConfig`) --- ## Como tratar campos opcionais Se a API externa retornar campos que podem ser nulos: ```kotlin // No mapper — converter null para valor padrão explícito description = apiResponse.description ?: "" // Nunca deixar !! no código name = apiResponse.name!! // ❌ proibido name = apiResponse.name ?: throw ResourceNotFoundException("...") // ✅ ``` --- ## Assumptions Se o contrato (request/response) não for informado: 1. Criar DTOs mínimos com os campos mais prováveis 2. Adicionar `// TODO: ajustar contrato conforme API real` em cada DTO 3. Informar no resumo final quais campos foram assumidos e por quê --- ## Resumo final esperado Ao terminar, listar: 1. Arquivos criados 2. Trecho de `application.yml` para adicionar 3. Assumptions feitas (se houver) 4. Como testar a rota localmente

{ "prompt": "# Prompt — Criar rota BFF completa\n\nVocê é um desenvolvedor sênior Kotlin/Spring Boot.\n\nLeia o arquivo de instruções de arquitetura:\n\n```text\n.github/copilot-instructions.md\n```\n\nUse a feature `example` em `src/main/kotlin/itau/template/bff/features/example/` como referência de código.\n\n## Rota a ser criada\n\nPreencha antes de executar:\n\n```text\nNome da feature (ex: customers, orders, accounts):\nEndpoint BFF (ex: GET /api/v1/customers/{id}):\nMétodo HTTP:\nAPI externa chamada (ex: customer-api):\nEndpoint na API externa (ex: GET /v1/customers/{id}):\nHeaders necessários na chamada externa (se houver):\n```\n\n## Payload\n\n```text\nRequest BFF (se houver body):\nResponse BFF esperado:\nResponse da API externa esperado:\n```\n\n## Cenários de erro\n\n```text\nErros esperados da API externa:\n(ex: 404 → ResourceNotFoundException, 5xx → ExternalApiException)\n```\n\n---\n\n## O que deve ser criado\n\n### Estrutura de arquivos\n\n```text\nfeatures/{nome}/\n api/\n {Nome}Controller.kt ← @RestController\n response/\n {Nome}Response.kt ← DTO público (retornado ao front-end)\n application/\n Get{Nome}UseCase.kt ← @Service (ou Create/Update conforme verbo)\n client/\n {ExternalApi}Client.kt ← @Component, RestClient\n {ExternalApi}Properties.kt ← @ConfigurationProperties\n response/\n {ExternalApi}Response.kt ← DTO externo (nunca exposto pelo controller)\n mapper/\n {Nome}Mapper.kt ← @Component\n model/\n {Nome}View.kt ← model interno (data class)\n```\n\n### Configuração em application.yml\n\nAdicionar bloco:\n\n```yaml\nexternal-apis:\n {nome-da-api}:\n base-url: http://localhost:{porta}\n timeout: 3s\n```\n\n### Testes\n\nCriar em `src/test/kotlin/itau/template/bff/features/{nome}/`:\n\n```text\nmapper/\n {Nome}MapperTest.kt ← JUnit 5, sem mock, teste unitário puro\napplication/\n Get{Nome}UseCaseTest.kt ← MockK para o client, mapper real\nclient/\n {ExternalApi}ClientTest.kt ← WireMock, @RegisterExtension, porta dinâmica\napi/\n {Nome}ControllerTest.kt ← MockMvc standaloneSetup + GlobalExceptionHandler\n```\n\n---\n\n## Regras obrigatórias\n\n- Controller nunca chama Client diretamente\n- Controller não contém lógica de negócio\n- DTO externo nunca aparece como response do controller\n- Erros externos convertidos para `ResourceNotFoundException` (404) ou `ExternalApiException` (502)\n- Properties carregadas via `@ConfigurationProperties`, nunca hardcoded\n- Sem `!!` (null assertion) no código\n- Correlation ID propagado automaticamente (já feito pelo `RestClientConfig`)\n\n---\n\n## Como tratar campos opcionais\n\nSe a API externa retornar campos que podem ser nulos:\n\n```kotlin\n// No mapper — converter null para valor padrão explícito\ndescription = apiResponse.description ?: \"\"\n\n// Nunca deixar !! no código\nname = apiResponse.name!! // ❌ proibido\nname = apiResponse.name ?: throw ResourceNotFoundException(\"...\") // ✅\n```\n\n---\n\n## Assumptions\n\nSe o contrato (request/response) não for informado:\n\n1. Criar DTOs mínimos com os campos mais prováveis\n2. Adicionar `// TODO: ajustar contrato conforme API real` em cada DTO\n3. Informar no resumo final quais campos foram assumidos e por quê\n\n---\n\n## Resumo final esperado\n\nAo terminar, listar:\n\n1. Arquivos criados\n2. Trecho de `application.yml` para adicionar\n3. Assumptions feitas (se houver)\n4. Como testar a rota localmente", "variables": [], "notes": "Você é um desenvolvedor sênior Kotlin/Spring Boot.", "metadata": { "source": { "provider": "github-prompts", "repository": "https://github.com/italosilva98/template-bff", "path": ".github/prompts/create-bff-route.prompt.md", "ref": "34be9aa9e8892523ab4ff75d5cb1f97bcb971a50", "url": "https://github.com/italosilva98/template-bff/blob/34be9aa9e8892523ab4ff75d5cb1f97bcb971a50/.github/prompts/create-bff-route.prompt.md", "key": "italosilva98/template-bff/.github/prompts/create-bff-route.prompt.md" } } }

create-bff-route

About

Prompt — Criar rota BFF completa

Rota a ser criada

Payload

Cenários de erro

O que deve ser criado

Estrutura de arquivos

Configuração em application.yml

Testes

Regras obrigatórias

Como tratar campos opcionais

Assumptions

Resumo final esperado

Install create-bff-route and it becomes one more candidate the router can pick - when it fits.

What it costs to adopt - in engineering time.

One base URL

No vendor lock-in

Failover built in

Use it

Manifest

Reviews