microsoft / microsoft/OpenAPI.NET

Add Builder to simplify openapi document object construction

Aberta
#673 4 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

help wanted type:enhancement
Linguagem predominante
C#
Estrelas
1.6k
Forks
286
Merge médio
6h 38min
PRs com merge (30d)
35

Descrição

A regular C# builder pattern would help a lot in many scenarios.
Building an object now is very complex...

Builder pattern is also the "de facto" in Aspnetcore.. so would make sense to expose a similar api

var openApiDocumentBuilder = new OpenApiDocumentBuilder()
     .WithServers(...)
     .WithOperation(...)
     .WithOperation(...)
     .WithSchema(...);
//... etc


var openApiDocument = openApiDocumentBuilder.Build();
     

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

A issue não nomeia arquivos, testes nem pontos de entrada. Comece revisando o modelo de objetos do documento OpenAPI existente e os padrões atuais de construção; em seguida, antes da implementação, esclareça as operações, os schemas e os servidores compatíveis com o builder. O trabalho estará concluído quando uma API do builder acordada puder construir um documento OpenAPI equivalente por meio de Build().

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
csharp, openapi
Domínio
api, backend-api-design
Tipo de issue
Funcionalidade
Dificuldade
5/5
Tempo estimado
Mais de uma semana
Status de atividade
Estagnada
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.