Skip to content

Latest commit

 

History

History
66 lines (46 loc) · 1.7 KB

README.md

File metadata and controls

66 lines (46 loc) · 1.7 KB
Raw

ao3-api

An API to scrape archiveofourown.org fanfiction metadata using the fetch-ao3 library that I created for scraping archiveofourown.org. Currently it can search for archiveofourown.org works to get different metadata like author name, chapter count, word count, genre, ratings etc

Features:

  • Fetch fanfiction works from archiveofourown.org
  • Fetch the local metadata from the database

Setup

Docker

Docker image

Build manually

# Inside the git repository
docker build -t arzkar/ao3-api-js .

Docker Hub

docker pull arzkar/ao3-api-js

Run the docker

docker-compose up

Manual

Environment variables

Add the "TOKEN_KEY", "DEFAULT_ADMIN_USER", "DEFAULT_ADMIN_PWD" & "DOCKER" for the API in a .env file in the project's root directory.
An example file is present called .env.ex

API

  • Clone the repository & run npm install
  • Run the development API server using npm run dev
  • Run the production API server by:
npm run deploy

Endpoints & Parameters

  • /api/live/search: To scrape an AO3 works by workUrl
  • /api/archive/search: To search the database for an AO3 works by workUrl
  • /api/archive/update:
    • To update a metadata in the database by workUrl
    • Requires a token to authenticate
    • Send the "token" in the body, query or the headers
  • /api/archive/delete:
    • To delete a metadata in the database by workUrl
    • Requires a token to authenticate
    • Send the "token" in the body, query or the headers
  • /api/auth:
    • To get the JWT token to authenticate /update & /delete endpoints
    • Send the "user" & "password" in the body and the token is returned