Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

Handle Pagination

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

Ninguém assumiu esta issue ainda.

Avaliação

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

Direção de pesquisa

Nenhum arquivo, teste ou ponto de entrada é nomeado. Comece localizando o tratamento de respostas da API e o fluxo de comandos gerados do pacote cli; em seguida, compare os três modelos de paginação e determine a extensão OpenAPI e os limites necessários. Está concluído quando a paginação é tratada de forma consistente de acordo com o modelo declarado e coberta por testes apropriados.

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

Descrição

feature help-wanted need-info

For APIs with paginated responses, the cli package should include utilities for handling the response and fetching subsequent pages automatically up to some limit.

For example, the GitHub API v3 uses Link headers with hypermedia relations to provide pagination.

In general there seem to be three models in use:

  1. Passing a page size and page number to get items. Maybe also some way to get a total page count.
  2. Passing an iterator value to get the next set of items. When no iterator is (or no items are) returned you are done.
  3. Using link relations to provide full URLs to fetch more items.

There should be a new OpenAPI extension to hint to the CLI which of these cases it is, how to handle it (e.g. parameter names), and whether to fetch all or expose limits via parameters in the CLI.

Linguagem predominante
Go
Estrelas
218
Forks
53
Métricas de merge de PRs
Nenhum PR com merge em 30d

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

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.

Mais de danielgtaylor/openapi-cli-generator

Todas as issues de danielgtaylor/openapi-cli-generator

Issues semelhantes

Mais issues de Go

Receba novas issues na sua caixa de entrada

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