Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/saipraveenkondapalli/django-apis

Last synced: 27 days ago
JSON representation

Host: GitHub
URL: https://github.com/saipraveenkondapalli/django-apis
Owner: saipraveenkondapalli
Created: 2024-06-08T11:09:45.000Z (8 months ago)
Default Branch: master
Last Pushed: 2024-06-27T06:38:25.000Z (7 months ago)
Last Synced: 2024-11-11T16:07:33.908Z (3 months ago)
Language: CSS
Size: 1.03 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

        # API for portfolio websites

[![Testing Status](https://github.com/saipraveenkondapalli/django-apis/actions/workflows/django.yml/badge.svg)](https://github.com/saipraveenkondapalli/django-apis/actions/workflows/django.yml/badge.svg)

## Endpoints

>[!IMPORTANT]

> To make an api request to the backend, we need to verify the site requesting the resource. You need to provide site id with every request in the header or in the URL params

> The backend verifies the request with origin site and matches with the site id. 

```

URL: https:////?site=

Header: X-SITE-ID: 

```

| Endpoint                      | Description                                            | Method | Request Body         | Response Body                                    |

|-------------------------------|--------------------------------------------------------|--------|----------------------|--------------------------------------------------|

| /api/contact/                 | To store a contact form data                           | POST   | name, email, message | {"status": "success"}                            |

| /api/resume/                  | redirects to resume url                                | GET    |                      |                                                  | 

| /api/job-application-message/ | display a custom message to the visitor of the website | GET    |                      | {"message": "Thank you for visiting my website"} |