Apicurio-studio: Editor: suporte allOf (herança de tipo de dados)

Criado em 18 jul. 2018  ·  20Comentários  ·  Fonte: Apicurio/apicurio-studio

Seria bom modelar a herança conforme definido em https://swagger.io/docs/specification/data-models/inheritance-and-polymorphism/ com allOf

enhancement

Comentários muito úteis

Esperando que esse recurso seja implementado!

Todos 20 comentários

@EricWittmann tendo passado os últimos dias na ferramenta, esta é provavelmente a maior lacuna que me impede de usar a ferramenta com os clientes

OK. Adicionando à lista!

mais alguma reflexão sobre isso? Estou lendo para iniciar alguns projetos e adoraria usar o apicruio, mas esse problema é um verdadeiro bloqueador

Eu tive algumas idéias nesta área, mas não tive a chance de realmente trabalhar nisso. A lista de pendências de recursos é bastante extensa, incluindo uma renovação relativamente ampla do UX.

Alguma chance de você ter alguma ideia sobre como seria uma IU que suporte allOf (e presumivelmente oneOf e anyOf)?

allOf precisa me mostrar que a definição foo estende a barra de definição e, de preferência, uma enumeração de campos que fazem parte da barra. a visão de foo deve ter um hiperlink para bar. Estou imaginando uma espécie de tela dividida aqui, mas o design da IU não é meu ponto forte.

oneOf e anyOf são casos de uso diferentes do ponto de vista de UX. Nesses cenários, preciso simplesmente enumerar as definições que podem ser usadas ao atribuir uma variável, mas não preciso ver os detalhes das definições como é necessário em allOf. Eu só preciso saber a lista de nomes de definição.

Vou levantar o problema com a UX para ver se podemos chegar a algo. Infelizmente, provavelmente não é o item mais importante da lista de tarefas, mas farei o possível. :)

Entendido, eu só quero que você tenha um contexto sobre o que é necessário para usarmos isso no laboratório. Este é o problema agora - posso contornar a maioria das outras coisas. Mas eu preciso ser capaz de fazer herança em um projeto do mundo real.

Compreendido absolutamente. :) Vou forçar esse requisito o máximo possível - certamente gostaria que o Apicurio fosse o mais útil possível em projetos do mundo real.

Se você tiver outros problemas que ainda não mencionou e que podem ser melhorados, com certeza, fale sobre eles também. (Observação: estamos trabalhando no projeto de um recurso CRUD, que tornará muito mais fácil adicionar rapidamente operações padrão para um "recurso")

Olá, alguma notícia sobre isso? É uma pena que uma ferramenta tão boa não possa lidar com herança ...

Infelizmente, nada ainda, embora não por falta de desejo de apoiar a herança. Apenas uma questão de priorização, na verdade.

O que ajudaria muito, se alguém tem habilidades de design de UX, é uma maquete de como isso funcionaria. @ sherl0cks já forneceu algumas idéias, mas seria muito mais fácil implementar algo aqui com um design UX. OU se você tiver uma ferramenta que faz algo semelhante da maneira que você gosta, fique à vontade para apontar isso!

Sei que isso pode ser pedir muito. :)

De qualquer maneira, isso será feito, só não sei quando ainda.

Ei,

se a parte UX ainda é um bloqueador - por que não reutilizar o estilo de guia existente, como https://imagebin.ca/v/4mkbz35931av

Alternativa - cria um tipo de dado "composto" (próximo a array, string, float, ...), uma vez selecionado - renderiza a mesma forma (onde você pode adicionar vários tipos) com algum preenchimento à esquerda.

A herança do ps é um recurso matador de documentação do OpenApi, pois economiza muito tempo de copiar e colar!

Esse não é um design ruim! Obrigado pela contribuição. Espero que você esteja bem com isso, mas achei que seria útil embutir a imagem para tornar as coisas mais fáceis (não há necessidade de clicar para criar a imagem):

4mkbz35931av

Nah, vou esperar até que isso seja lançado e então vou reclamar por violação de direitos autorais! : D

ps além disso - vocês construíram uma ótima ferramenta! Parabéns!

Haha! 🤣

Esperando que esse recurso seja implementado!

Trabalhando nisso agora (finalmente). :)

Eu sei que demorou muito, mas uma implementação inicial do suporte básico allOf, oneOf e anyOf (obviamente para documentos OpenAPI 2.0 é apenas "allOf").

Esta é apenas uma implementação beta do suporte. Eu adoraria receber algum feedback sobre isso. Acho que há um monte de melhorias que podem ser feitas, mas estou interessado no que os outros pensam primeiro.

Farei um lançamento hoje para que todos possam testar os recursos usando a versão Try Now (nuvem) do Apicurio Studio.

É importante notar que as mudanças também incluem melhorias para tipos simples reutilizáveis. Esperançosamente, isso também é útil para alguns usuários.

Infelizmente, não estou muito tempo em um papel em que estou usando apicurio, mas parece ótimo @EricWittmann !

Esta página foi útil?
0 / 5 - 0 avaliações