Skip to content

MaximilianFreitag/zufallsworte-API

Repository files navigation

Deutsche Zufallsworte API


API Docs --> https://zufallsworte.herokuapp.com/


image_cover



How to use (For the full docs please visit the hyperlink above)


Return 4 random german word
https://zufallsworte.herokuapp.com/zufallswoerter/4

--> {"words":["Katze","Maus","fliegen","schön"]}

Return 6 random german words starting with au

https://zufallsworte.herokuapp.com/anfangsbuchstaben/au/6

--> {"words":["Ausbildung","Aufstellung","aufstehen","Ausweis","aufrunden","Ausgang"]}

Return 3 random german nouns that have the letters "ee" in them

https://zufallsworte.herokuapp.com/substantiv_enthaelt/ee/3

--> {"words": ['Meer', 'Idee', 'Ostsee'] }



Running the API locally on your computer

  1. Git clone the repository to your Desktop and install uvicorn and fast api

    git clone https://github.com/MaximilianFreitag/zufallsworte-API.git
    pip install uvicorn
    pip install fastapi
  2. cd into the folder "zufallsworte-API" on your desktop

    cd zufallsworte-API
  3. Open up the terminal and run following command and visit the resulting localhost URL

    uvicorn main:app --reload



Current bugs: 🐞

To-Do:

  • None

__________________________________________________

To-Do list: (Improvements and functionality)

  • Placeholder
  • Placeholder





#API #Duden #Wortgenerator #Python #Informatik #JSON

License

This project falls under the MIT license.






About

The API for the pip install python library "zufallsworte"

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages