From acff13d2b9af08476aae6be3865218edd719f235 Mon Sep 17 00:00:00 2001 From: Edwin O Marshall Date: Thu, 6 Mar 2014 17:48:39 -0500 Subject: [PATCH] - sep 10 for #629 --- sep/sep-010.rst | 70 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 70 insertions(+) create mode 100644 sep/sep-010.rst diff --git a/sep/sep-010.rst b/sep/sep-010.rst new file mode 100644 index 000000000..831143891 --- /dev/null +++ b/sep/sep-010.rst @@ -0,0 +1,70 @@ +======= =========================================== +SEP 10 +Title REST API +Author Pablo Hoffman +Created 2009-11-16 +Status Obsolete (JSON-RPC API implemented instead) +======= =========================================== + +================= +SEP-010: REST API +================= + +This SEP proposes a JSON REST API for controlling Scrapy in server-mode, which +is launched with: ``scrapy-ctl.py start`` + +Operations +========== + +Get list of available spiders +----------------------------- + + GET /spiders/all + +Get list of closed spiders +-------------------------- + + GET /spiders/closed + +Get list of scheduled spiders +----------------------------- + + GET /spiders/scheduled + +.. note:: contains closed + +Get list of running spiders +--------------------------- + + GET /spiders/opened + +- returns list of dicts containing spider ``id`` and ``domain_name`` + +Schedule spider +--------------- + + POST /spiders + +- args: ``schedule=example.com`` + +Close spider +------------ + + POST /spider/1238/close + +Get global stats +---------------- + + GET /stats + +.. note:: spider-specific not included + +Get spider-specific stats +------------------------- + + GET /spider/1238/stats/ + +Get engine status +----------------- + + GET /engine/status