https://github.com/ryanleecode/gitserver-client
https://github.com/ryanleecode/gitserver-client
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ryanleecode/gitserver-client
- Owner: ryanleecode
- Created: 2019-05-26T18:06:46.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-06-07T01:33:49.000Z (about 7 years ago)
- Last Synced: 2025-02-24T13:23:19.387Z (over 1 year ago)
- Language: Dart
- Size: 51.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gitserver
This is a generate purpose REST API for interfacing with Git.
This Dart package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.0.2
- Build package: org.openapitools.codegen.languages.DartClientCodegen
For more information, please visit [http://drdgvhbh.io](http://drdgvhbh.io)
## Requirements
Dart 1.20.0 or later OR Flutter 0.0.20 or later
## Installation & Usage
### Github
If this Dart package is published to Github, please include the following in pubspec.yaml
```
name: gitserver
version: 1.0.0
description: OpenAPI API client
dependencies:
gitserver:
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
version: 'any'
```
### Local
To use the package in your local drive, please include the following in pubspec.yaml
```
dependencies:
gitserver:
path: /path/to/gitserver
```
## Tests
TODO
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```dart
import 'package:gitserver/api.dart';
// TODO Configure API key authorization: api_key
//defaultApiClient.getAuthentication('api_key').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication('api_key').apiKeyPrefix = 'Bearer';
var api_instance = new DefaultApi();
var directory = directory_example; // String | The directory of the repository
var hash = hash_example; // String | The hash of the commit
try {
var result = api_instance.getCommit(directory, hash);
print(result);
} catch (e) {
print("Exception when calling DefaultApi->getCommit: $e\n");
}
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**getCommit**](docs//DefaultApi.md#getcommit) | **GET** /repositories/{directory}/commits/{hash} | Get commit
*DefaultApi* | [**getCommitChanges**](docs//DefaultApi.md#getcommitchanges) | **GET** /repositories/{directory}/commits/{hash}/changes | Get commit changes
*DefaultApi* | [**listCommits**](docs//DefaultApi.md#listcommits) | **GET** /repositories/{directory}/commits | List commits
*DefaultApi* | [**listReferences**](docs//DefaultApi.md#listreferences) | **GET** /repositories/{directory}/references | List references
## Documentation For Models
- [Change](docs//Change.md)
- [Commit](docs//Commit.md)
- [Contributor](docs//Contributor.md)
- [InlineResponse200](docs//InlineResponse200.md)
- [InlineResponse2001](docs//InlineResponse2001.md)
- [InlineResponse2002](docs//InlineResponse2002.md)
- [InlineResponse2003](docs//InlineResponse2003.md)
- [Reference](docs//Reference.md)
## Documentation For Authorization
## api_key
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
## Author
ryanleecode@gmail.com