gitea/java.gitea.api
gitea/java.gitea.api
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Mise à jour de 'README.md'

Browse Source
This commit is contained in:
fterrot 2021-03-06 16:56:52 +01:00
parent 97a6f5c8cd
commit ec456cd3dc
1 changed files with 43 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -1,3 +1,45 @@
# java.gitea.api
Can be ween as a fork of https://github.com/zeripath/java-gitea-api with updated Gitea API version and generated thanks to OpenAPI.
Generated Java API for Gitea.
Original repository is https://forge.chapril.org/gitea/java.gitea.api/. A github mirror https://github.com/teilginn/java-gitea-api is maintained.
## Credits
* https://github.com/zeripath/java-gitea-api
## Why another version ?
For https://forge.chapril.org/gitea/mylyn-gitea/ project I started to use https://github.com/zeripath/java-gitea-api.
Unfortunatelly I experimented blocking ssl connections issues due to the obsolete version of okhttp library the generated code is based on. The root cause of the issue is the swagger code generaror. I had also a lot of issue coming from the Java.
So I decide to restart from scratch with OpenAPI generator which is maintain up to date.
## Branching Strategy
`head` -> `openapi` -> `io.io.gitea.<version>`
* `head` branch shall not be used. It used on Github only to keep track on the original java-gitea-api head branch.
* `openapi` branch will only contains the minimal set of stuff required to generate from scratch.
* `java.io.gitea.<version>` branch is used for the ready to use Gitea _<version>_ api (generated from Gitea repository release)
* `java.io.gitea.master` branch may be maintain aligned with the Gitea head branch api. (near future)
## License
`generate.sh` and `README.md` are the only files I'm the author. They are provided under the MIT license You will find a copy in the LICENSE file.
I think that no one should take the ownership of configuration or generated files. So they are provided as-is for your convenience without any warranty. If you use them, You are just ask you to credits the original location you find them.
The Gitea swagger api description file is provided under the MIT License by the Gitea Authors.
NOTE: To avoid any ownership confusion, this repository is using a Yaml configuration file.
## How to generate
NOTE: Generate requires a *Unix* based host supporting `bash`, `Java JDK` (1.8 or newer) and `Maven`. The *1.13* branch has been generated on a XUbuntu 20.04 host (bash:5.0.17, openjdk 11.0.10, Apache Maven 3.6.3) and openapi-generator-cli 5.0.1.
`generate.sh` downloads the OpenAPI generator and Gitea swagger API description from their original delivery locations before starting the code generator. At this end it runs _maven_ library packaging and test
1. Check the generate.sh file parameters
1. run `generate.sh`