jeffemart/gobiru repository overview

⁠Quick reference

• Maintained by: Jefferson Martins⁠
• Where to get help: GitHub Issues⁠

⁠Supported tags and respective Dockerfile links

• latest⁠
• 1.0.0⁠

⁠What is Gobiru?

Gobiru é uma ferramenta de linha de comando para gerar documentação de APIs Go automaticamente. Ele analisa suas rotas do Gorilla Mux e gera documentação no formato OpenAPI (Swagger), fornecendo uma interface web interativa para visualização da documentação.

⁠How to use this image

⁠Start a Gobiru instance

$ docker run -p 8081:8081 jeffemart/gobiru:latest

⁠Using with your own API

$ docker run -p 8081:8081 \
  -v $(pwd)/routes.go:/app/routes.go \
  -v $(pwd)/docs:/app/docs \
  jeffemart/gobiru:latest

⁠Using with docker-compose

version: '3.8'

services:
  gobiru:
    image: jeffemart/gobiru:latest
    ports:
      - "8081:8081"
    volumes:
      - ./routes.go:/app/routes.go
      - ./docs:/app/docs

⁠Configuration

⁠Environment Variables

• PORT - Porta do servidor (default: 8081)
• API_TITLE - Título da API na documentação
• API_DESCRIPTION - Descrição da API
• API_VERSION - Versão da API

⁠Volumes

• /app/routes.go - Arquivo com as rotas da API
• /app/docs - Diretório onde a documentação será gerada

⁠Features

• 🔄 Análise automática de rotas do Gorilla Mux
• 📝 Geração de documentação no formato JSON personalizado
• 📚 Geração de especificação OpenAPI (Swagger)
• 🌐 Servidor de documentação integrado com Swagger UI
• 🐳 Imagem Docker otimizada (~20MB)

⁠License

View license information⁠ for the software contained in this image.

⁠Supported architectures

• linux/amd64
• linux/arm64

⁠Issues

If you have any problems with or questions about this image, please contact us through a GitHub issue⁠.

⁠Contributing

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue⁠, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

⁠Security

Para reportar vulnerabilidades de segurança, por favor envie um email para [email protected]⁠ ao invés de abrir uma issue pública.