src/api/templates/api/main.html

   1 {% extends "base_simple.html" %}
   2 {% load i18n %}
   3 {% load build_absolute_uri from fnp_common %}
   4
   5 {% block settings %}
   6   {% load title %}
   7   {% trans "API WolneLektury.pl" as title %}
   8   {% title title %}
   9 {% endblock %}
  10
  11 {% block title %}{% trans "API WolneLektury.pl" %}{% endblock %}
  12
  13 {% block bodyid %}api{% endblock %}
  14
  15 {% block body %}
  16   <h1>API</h1>
  17
  18   <div class="normal-text white-box">
  19     <p>
  20       {% url "api" as u %}
  21       {% blocktrans trimmed with u=u|build_absolute_uri:request %}
  22         API serwisu WolneLektury.pl znajduje się pod adresem <code>{{ u }}</code>.
  23         Za jego pomocą można uzyskać informacje o utworach, ich fragmentach
  24         i metadanych.
  25       {% endblocktrans %}
  26     </p>
  27
  28     <p>
  29       {% blocktrans trimmed %}
  30         Dane domyślnie są serializowane w formacie JSON,
  31         ale dostępny jest też format XML – wystarczy dodać parametr
  32         <code>?format=xml</code> do dowolnego zapytania.
  33       {% endblocktrans %}
  34     </p>
  35
  36     <p>
  37       {% blocktrans trimmed %}
  38         API Wolnych Lektur zawiera następujące adresy URL:
  39       {% endblocktrans %}
  40     </p>
  41
  42     <ul>
  43       <li><a href='{% url "catalogue_api_book_list" "" %}'>
  44         {% url "catalogue_api_book_list" "" %}</a> – {% trans "Wszystkie utwory" %}</li>
  45       <li><a href='{% url "catalogue_api_audiobook_list" "" %}'>
  46         {% url "catalogue_api_audiobook_list" "" %}</a> – {% trans "Audiobooki" %}</li>
  47       <li><a href='{% url "catalogue_api_daisy_list" "" %}'>
  48         {% url "catalogue_api_daisy_list" "" %}</a> – {% trans "DAISY" %}</li>
  49
  50       <li><a href='{% url "catalogue_api_tag_list" "author" %}'>
  51         {% url "catalogue_api_tag_list" "author" %}</a> – {% trans "Lista autorów" %}</li>
  52       <li><a href='{% url "catalogue_api_tag_list" "epoch" %}'>
  53         {% url "catalogue_api_tag_list" "epoch" %}</a> – {% trans "Lista epok" %}</li>
  54       <li><a href='{% url "catalogue_api_tag_list" "genre" %}'>
  55         {% url "catalogue_api_tag_list" "genre" %}</a> – {% trans "Lista gatunków literackich" %}</li>
  56       <li><a href='{% url "catalogue_api_tag_list" "kind" %}'>
  57         {% url "catalogue_api_tag_list" "kind" %}</a> – {% trans "Lista rodzajów literackich" %}</li>
  58
  59       <li><a href='{% url "catalogue_api_tag_list" "theme" %}'>
  60         {% url "catalogue_api_tag_list" "theme" %}</a> – {% trans "Lista motywów i tematów literackich" %}</li>
  61       <li><a href='{% url "catalogue_api_collections" %}'>
  62         {% url "catalogue_api_collections" %}</a> – {% trans "Kolekcje" %}</li>
  63     </ul>
  64
  65     <p>
  66       {% url "catalogue_api_book" "studnia-i-wahadlo" as e1 %}
  67       {% url "catalogue_api_tag" "author" "edgar-allan-poe" as e2 %}
  68       {% blocktrans trimmed %}
  69         Każdy element na tych listach zawiera adres (w atrybucie „href”), pod którym
  70         można znaleźć szczegółowe dane, np.
  71       {% endblocktrans %}
  72       <a href="{{e1}}">{{e1}}</a> {% trans "albo" %}
  73       <a href="{{e2}}">{{e2}}</a>.
  74     </p>
  75
  76     <p>
  77       {% blocktrans trimmed %}
  78         Można łączyć autorów, epoki, gatunki i rodzaje, aby wybrać tylko utwory
  79         odpowiadające zadanym kryteriom. Na przykład:
  80       {% endblocktrans %}
  81       <a href="/api/authors/adam-mickiewicz/kinds/liryka/books/">/api/authors/adam-mickiewicz/kinds/liryka/books/</a>.
  82     </p>
  83
  84     <p>
  85       {% blocktrans trimmed %}
  86         Aby spośród wszystkich pasujących wybrać tylko utwory najwyższego poziomu
  87         (pomijając ich podutwory), można użyć zapytania /parent_books/, np.:
  88       {% endblocktrans %}
  89       <a href="/api/authors/adam-mickiewicz/kinds/liryka/parent_books/">/api/authors/adam-mickiewicz/kinds/liryka/parent_books/"</a>.
  90     </p>
  91
  92     <p>
  93       {% blocktrans trimmed %}
  94         W ten sam sposób, filtrując dodatkowo według lektur lub motywów, można
  95         wyszukiwać fragmenty:
  96       {% endblocktrans %}
  97       <a href="/api/authors/william-shakespeare/themes/zabawa/fragments/">/api/authors/william-shakespeare/themes/zabawa/fragments/</a>.
  98       {% blocktrans trimmed %}
  99         Każdy element uzyskanej listy w atrybucie „href” zawiera link do
 100         szczegółowego opisu danego fragmentu, np.:
 101       {% endblocktrans %}
 102       {% url "catalogue_api_fragment" "sen-nocy-letniej" "1290526312912-3814598192" as f %}
 103       <a href="{{f}}">{{f}}</a>.
 104     </p>
 105   </div>
 106 {% endblock %}