RomanNum3ral
/
scrapy
mirror of https://github.com/scrapy/scrapy.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #637 from aspidites/sep-010.rst 

sep 10 for #629
This commit is contained in:
Pablo Hoffman 2014-03-07 07:06:20 -08:00
parent c1d31bd14b 8f0858cb0c
commit 61b81b1c9f
2 changed files with 70 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
sep/sep-010.rst Normal file
View File

@ -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``

59
sep/sep-010.trac
View File

@ -1,59 +0,0 @@
= SEP-010: REST API =
[[PageOutline(2-5,Contents)]]
||'''SEP:'''||10||
||'''Title:'''||REST API||
||'''Author:'''||Pablo Hoffman||
||'''Created:'''||2009-11-16||
||'''Status'''||Obsolete (JSON-RPC API implemented instead)||
== Introduction ==
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