Giter VIP home page Giter VIP logo

tui-git-repos's Introduction

TUI Service - Git Repository Manager API

Getting started

The app consists of being able to list all github repositories of a given username, wich are not forks. Information about the branch name and the last commit sha is also present.

Start the application

Running the app

 docker-compose build
 docker-compose up app

The above commands, will build and run a docker container, starting this web service on localhost at port 8081.

Supported endpoints

  • /api/users//repos

Pagination support

You can also introduce pagination options into the endpoint.
Follow the below example:

  • /api/github/users//repos?page=<page_number>&size=<page_size>

Calling the API

After the docker container is running, you can use an API requester of you choose, like Postman, or even using the curl command, to start to perform some requests into the web service.

Examples:

GET http://localhost:8081/api/users/prtpereira/repos
GET http://localhost:8081/api/users/prtpereira/repos?page=1&size=5

Swagger documentation

https://app.swaggerhub.com/apis/PRTPEREIRA2/tui-git-repos/1.0.0#

tui-git-repos's People

Contributors

prtpereira avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.