retrofit README

The project's README from github.com/lysine-dev/retrofit. As one markdown file: README.md.

Retrofit

A type-safe HTTP client for Android and Java.

For more information please see the website.

Download

Download the latest JAR or grab from Maven central at the coordinates com.squareup.retrofit2:retrofit:3.0.0.

Snapshots of the development version are available in Sonatype's snapshots repository.

Retrofit requires at minimum Java 8+ or Android API 21+.

R8 / ProGuard

If you are using R8 the shrinking and obfuscation rules are included automatically.

ProGuard users must manually add the options from retrofit2.pro. You might also need rules for OkHttp which is a dependency of this library.

License

Copyright 2013 Square, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

retrofit (lysine-dev/retrofit)

Searching Database…

43.9K ·GitHub
What is this?Retrofit is a type-safe HTTP client for Android and the JVM, created by Square. It lets you define your REST API as a Java/Kotlin interface and turns HTTP calls into simple method calls.
Is it a framework or just a library?It's a library you add as a dependency, not a standalone app or framework; it generates an implementation of an interface you write to describe your API calls.
How do I add it to a project?Add the Maven Central coordinates com.squareup.retrofit2:retrofit:3.0.0 to your build (Gradle/Maven), or download the latest JAR directly.
What Java or Android version do I need?You need at least Java 8+ for JVM projects or Android API 21+ for Android apps.
Any gotchas when using R8 or ProGuard?R8 users get the shrinking/obfuscation rules automatically, but ProGuard users must manually add rules from retrofit2.pro, plus the OkHttp ProGuard rules since OkHttp is a dependency.
Does Retrofit depend on OkHttp?Yes, OkHttp is a dependency, which is why ProGuard users also need to add OkHttp's ProGuard rules alongside Retrofit's own.
Can I get snapshot builds of Retrofit?Yes, development snapshots are published to Sonatype's snapshots repository for those who want unreleased changes.
Creator
lysine-dev
Size
11.4 MB
Stars
43.9K
Age
16y
Commits · 90 Days