GitFlic-API

🧸library provides wrapper for GitFlic API

📃Origin api docs: gitflic.ru/help/api/intro

👩‍💻 See on: npm, gitflic.ru, js.gitflic-api.tk

Contents

• Installing
• Using
  • GitFlic Instance
  • .get().by()
• Roadmap

Installing

npm

npm i gitflic-api

yarn

yarn add gitflic-api

API

GitFlic Instance

import { GitFlic } from 'gitflic-api'

// Creating new instance of Gitflic wrapper:
const gfa = new GitFlic({
	gitflic_api_url: 'https://api.gitflic.ru',
	gitflic_token: '7efee2d6-04ef-4dcb-aad2-ba864598e41a'
}).API

*for self-hosted use 'localhost:8080/rest-api' at gitflic_api_url

.get().by()

project

const params = {
	userAlias: 'yorkblansh',
	projectAlias: 'gitflic-api'
}

gfa.project
	.get('singleProject')
	.by({ params })
	.then((response) => console.log(response.data))

project list

gfa.project
	.get('myProjects')
	.by({}) // you can set empty props if fetching list
	.then((response) => console.log(response.data))

Or set Pagination options tou return list:

const params = {
	page: 20 // <- page number
	size: 5 // <- number of objects, displayed on page
}

gfa.project
	.get('myProjects')
	.by({ params })
	.then((response) => console.log(response.data))

*argument enums for get method:

gfa.project.get(/* put one the types below */)...

'allProjects' [] // return project list, can be refined with params
'myProjects' [] // return project list of current user
'sharedProjects' [] // return shared project list for current user
'singleProject' // return single project, have to be specified by user and project aliases

gfa.user.get(/* put one the types below */)...

'allUsers' [] // return user list, can be refined with params
'currentUser' // return current user
'singleUser' // ❗️not released yet

gfa.team.get(/* put one the types below */)...

'allTeams' [] // return project list, can be refined with params
'myTeams' [] // return project list of current user
'sharedTeams' [] // return shared project list for current user
'singleTeam' // return single project, have to be specified by user and project aliases

gfa.company.get(/* put one the types below */)...

'allCompanies' [] // return project list, can be refined with params
'myCompanies' [] // return project list of current user
'singleCompany' // return single project, have to be specified by user and project aliases

read more about argument enums for get method

Get method is also relevant for:
Project,
User,
Team,
Company,
Release,
Commit APIs
see more examples at extended docs

Roadmap

• 🕸️API
  • [x] Project
  • [ ] User (in progress: singleUser)
  • [ ] Team (in progress: Teamlist)
  • [x] Company
  • [x] Commit
  • [ ] Release (need e2e tests)
  • [ ] MergeRequest (need e2e tests)
  • [ ] IssueDiscussion (need e2e tests)