Skip to content
A RESTful JSON API for tvm.nirantak.com built with Django REST Framework
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
api
logs
techversusme
templates
.editorconfig
.flake8
.gitignore
.pre-commit-config.yaml
.slugignore
LICENSE
Pipfile
Pipfile.lock
Procfile
README.md
manage.py
pyproject.toml

README.md

Tech Versus Me API

A RESTful JSON API for tvm.nirantak.com built with Django REST Framework

Table of Contents

Introduction

REST is an architecture style for designing networked applications and APIs over HTTP. It stands for REpresentational State Transfer.
Web Services that conform to the REST architectural style, or RESTful web services, provide interoperability between computer systems on the Internet.

REST Constraints

As REST creator, Roy Fielding describes in his doctoral dissertation, it was conceived as a whole sets of needs, shaped by the constraints of the environment in which this system was going to be implemented. Such constraints are:

  • Client-Server architecture
  • Uniform Interface (Resource URIs, Hypermedia)
  • Stateless
  • Cacheable
  • Layered System
  • Code on demand (optional)

Endpoints

Name URI Method Description
index / GET Index View with metadata
posts /posts/ GET List all posts
post /posts/<id:int>/ GET Show individual post by id
authors /authors/ GET List all authors
author /authors/<id:int>/ GET Show individual author by id
update /update/ GET, POST('key') Update Database from Atom Feed

Scripts

  • atom_feed.py
    This script parses the Atom Feed from here, and updates the database with new posts, it is run automatically as a build hook from Netlify after each deploy.

License

This code has been released under the GNU General Public License v3.0.

You can’t perform that action at this time.