https://github.com/panjohnny/baka4j

Bakaláři v Javě, protože proč ne
https://github.com/panjohnny/baka4j

Last synced: 4 days ago
JSON representation

Bakaláři v Javě, protože proč ne

• Host: GitHub
• URL: https://github.com/panjohnny/baka4j
• Owner: PanJohnny
• License: mit
• Created: 2021-10-02T19:27:07.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-10-23T07:23:07.000Z (about 1 year ago)
• Last Synced: 2023-10-23T08:29:44.382Z (about 1 year ago)
• Language: Java
• Size: 38.1 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Baka4J

Baka4J je neoficiální wrapper pro [Bakaláři api v3](https://github.com/bakalari-api/bakalari-api-v3/). Pomocí OKHttp komunikuje s API Bakalářů.

## Použití 

Projekt si musíte buildnout, takže si ho stáhněte z GitHubu a pomocí mavenu compilujte do jaru.

Hlavní objekt je `BakaClient`. Je to interface, pomocí kterého můžete vytvořit svého clienta.

Clienti jsou 2:

 - v3 - standartní, vrací json

 - v3Wrapper - vrací java objekty

Prosím mějte na paměti, že jsou hotové jen některé endpointy, pokud nenaleznete co hledáte prosím otevřte issue nebo pull request s vaším řešením.

```java

import com.panjohnny.baka4j.BakaClient;

public class Test {

    {

        BakaClient clienti= BakaClient.v3(url) | BakaClient.v3Wrapper(url);

    }

}

```

Samo o sobě BakaClient nenabízí jiné metody než login, musíte tedy explicitně vybrat typ.

```java

import com.panjohnny.baka4j.BakaClient;

import com.panjohnny.baka4j.v3.V3Client;

import com.panjohnny.baka4j.v3.V3WrapperClient;

public class Test {

    {

        V3Client client = BakaClient.v3(url);

        V3WrapperClient wrapperClient = BakaClient.v3Wrapper(url);

    }

}

```

## Unit testy

Pokud chcete testovat, tak vytvořte soubor `login.json` v `src/test/resources/`, který bude vypadat takto:

```json

{

  "username": "JohnDoe",

  "password": "ILikeCats",

  "url": "https://bakalari.example.com/"

}

```

Všechny testy jsou v `src/test/java`.

## Přispívání 

Budu moc rád za jakýkoliv příspěvek do tohoto projektu.