The Gradle codebase has evolved over time and has a mixture of simple getter/setter methods, Provider API and things in between.  It can be hard to follow best practices because Gradle provided types are reused in unexpected ways and extended by third party plugins.

Given these constraints, we cannot always follow best practices.  This ADR proposes the way we should handle the use of Provider APIs in the gradle/gradle codebase.

## Decision

</blockquote>

## Investigation { #investigation }

  stars: 1267
  owner_login: vargasjona
  owner_html_url: https://github.com/vargasjona
- name: restish
  html_url: https://github.com/rest-sh/restish
  stars: 1258
  owner_login: rest-sh
  owner_html_url: https://github.com/rest-sh
- name: RuoYi-Vue3-FastAPI
  html_url: https://github.com/insistence/RuoYi-Vue3-FastAPI
  stars: 1248
  owner_login: insistence

# ADR-0001 - Use Architectural Decision Records

## Status

- ACCEPTED on 2023-12-01

## Context

In a distributed team with many subteams, the best solution to communicate decisions is to use a format accessible by everyone in charge of development.

We use *Specification* and *Discovery* documents stored in Google Drive, but they present some downsides:

    has good test coverage, so look at some existing tests if you're unsure how
    to go about it.
2.  All contributions must be licensed Apache 2.0 and all files must have a copy
    of the boilerplate license comment (can be copied from an existing file).
3.  Files should be formatted according to Google's [Java style guide][].
4.  Do your best to have a [well-formed commit message][] for the change.

Are you tired of all that **data validation**, **documentation**, **serialization**, and all that **boring** stuff?

Do you just want to **vibe**? 🎶

**FastAPI** now supports a new `@app.vibe()` decorator that embraces **modern AI coding best practices**. 🤖

## How It Works { #how-it-works }

The `@app.vibe()` decorator is intended to receive **any HTTP method** (`GET`, `POST`, `PUT`, `DELETE`, `PATCH`, etc.) and **any payload**.

The hierarchy is like:

* **Uvicorn**: an ASGI server
    * **Starlette**: (uses Uvicorn) a web microframework
        * **FastAPI**: (uses Starlette) an API microframework with several additional features for building APIs, with data validation, etc.

* **Uvicorn**:

  Note that commits might be squashed by a maintainer on merge.
- [ ] Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
  This may not always be possible but is a best-practice.
- [ ] Run `mvn verify` to make sure basic checks pass.
  A more thorough check will be performed on your pull request automatically.
- [ ] You have run the [Core IT][core-its] successfully.

### [Django REST Framework](https://www.django-rest-framework.org/) { #django-rest-framework }

Django REST framework was created to be a flexible toolkit for building Web APIs using Django underneath, to improve its API capabilities.

/// info

A "bearer" token is not the only option.

But it's the best one for our use case.

And it might be the best for most use cases, unless you are an OAuth2 expert and know exactly why there's another option that better suits your needs.

In that case, **FastAPI** also provides you with the tools to build it.