https://github.com/progval/udd-http-api
HTTP JSON api for the Ultimate Debian Database.
https://github.com/progval/udd-http-api
Last synced: 3 months ago
JSON representation
HTTP JSON api for the Ultimate Debian Database.
- Host: GitHub
- URL: https://github.com/progval/udd-http-api
- Owner: progval
- Created: 2012-02-23T17:38:04.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2012-04-13T22:11:55.000Z (about 13 years ago)
- Last Synced: 2025-02-12T05:39:03.815Z (4 months ago)
- Language: Python
- Homepage: http://udd.progval.net/
- Size: 109 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README
Awesome Lists containing this project
README
Introduction
===========
A web API for the Ultimate Debian Database.
This API is read-only.
Installation
============
Copy the file, create a file config.py with the following constants, and start
the web server:
* HOST
* PORT
* USER
* PASSWORD
* DATABASE
URL schema
==========
The root gives the list of available subdirectories. For example :
http://udd.progval.net/bugs/
You can provide filters (by appending ?filter1=value1&filter2=value2) to the
URL. filter1 and filter2 are names of fields of the resources.
Giving the same filter twice will be ignored.
Self-documentation
==================
As content are generated dynamically, it is possible for the API to display doc
about itself. You just have to append /doc/ to a resource path to get a
description of its fields.
For example : http://udd.progval.net/bugs/doc/
Format
======
All errors are plain text (text/plain). All data are json (application/json).
Sample Apache configuration
===========================
ServerName udd.progval.net
DocumentRoot /home/udd/udd-http-api
Options Indexes MultiViews FollowSymLinks +ExecCGI
Order allow,deny
Allow from all
Options Indexes MultiViews FollowSymLinks +ExecCGI
SetHandler wsgi-script
Order allow,deny
Allow from all
ErrorLog /home/udd/apache/error.log
WSGIScriptAlias / /home/udd/udd-http-api/index.py
AssignUserId udd udd