W ramach laboratorium zostanie opracowany serwis wykorzystujący API REST oraz wykorzystujący dokumentową bazę danych MonogoDB. Część serwerowa zostanie opracowana
w języku php a cześć klienta z wykorzystaniem języka JavaScript i technologii AJAX.
Skrót REST oznacza Representational State Transfer, jest określeniem API charakteryzującym się następującymi cechami:
Odseparowanie części serwerowej od klienta
API typu REST służą do budowania wysoce skalowalnych, ale prostych aplikacji WWW. Odseparowanie
klienta od API, a zarazem zachowanie ścisłej struktury API ułatwia aplikacjom klienta
wysyłanie żądań o zasoby bez możliwości wywoływania baz danych ani uruchamiania logiki
działającej po stronie serwera.
Aplikacja serwerowa jest bezstanowa
Zgodnie z projektem API typu REST przyjmują tylko dane wejściowe i zwracają dane wyjściowe.
Nie mogą przechowywać żadnego stanu związanego z połączeniem z klientem. Nie oznacza
to jednak, że API typu REST nie mogą służyć do uwierzytelniania i autoryzacji. Mechanizm
autoryzacji powinien umożliwiać korzystanie z tokenów wysyłanych w każdym żądaniu.
Powinno umożliwiać zapisywanie w danych pamięci podręcznej
Aby odpowiednio skalować aplikacje internetowe, API typu REST muszą z łatwością oznaczać
odpowiedzi jako możliwe/niemożliwe do zapisania w pamięci podręcznej. Ponieważ REST
ściśle definiuje, jakie dane będą zwracane za pośrednictwem określonych punktów końcowych,
mechanizm ten można z łatwością skonfigurować w przypadku poprawnie zaprojektowanych
API typu REST. W idealnym rozwiązaniu pamięć podręczna powinna być zarządzana z poziomu
oprogramowania, w taki sposób, aby uniemożliwiać przypadkowe przechwycenie uprzywilejowanych
informacji przez innego użytkownika.
Punkt końcowy powinien definiować określony obiekt lub metodę
Zwykle są one definiowane hierarchicznie, np. /zasob/id/20210103. Dzięki temu
w API typu REST można z łatwością korzystać z metod HTTP takich jak GET, POST, PUT i DELETE.
W efekcie punkt końcowy obsługujący wiele metod HTTP nie wymaga dodatkowej dokumentacji.
Serwis RESTful.
Struktura katalogów uruchamianego serwisu znajduje się poniżej.
W ramach zadania zostanie zrealizowany dostęp do bazy danych MongoDB z skryptu php. Poniżej znajdują się pliki umożliwiające zrealizowanie zadania.
Przygotowanie środowiska do uruchomienia serwisu wymaga dodania do naszego katalogu biblioteki obsługującej bazę danych MongoDB.
Zrealizujemy to poprzez wgranie biblioteki mongodb w katalogu "vendor". Archiwum katalogu znajduje się w pliku
"vendor.tar.gz".
Dodatkowo należy umieścić plik zawierający informację o dołączonej bibliotece - "composer.json".
{
"require": {
"mongodb/mongodb": "^1.4"
}
}
Plik mongo.php - realizacja operacji CRUD w bazie danych MongoDB z wykorzystaniem języka php.
W ramach tego zadania zrealizujemy prosty serwis realizujący architekturę RESTful
i implementujący funkcjonalność CRUD ( "create, read, update,
delete"). Poniżej znajdują się wymagane pliki do realizacji postawionego zadania.
Plik rest.php - interfejs dostępu do naszej aplikacji, klasa obsługująca żądania protokołu http.
Ostatnim punktem będzie realizacja klienta dostępu do opracowanego serwisu z wykorzysaniem aplikacji opracowanej w języku JavaScript
wykorzystującej technologię AJAX. Poniżej znajdują się pliki do potrzebne do realizacji zadania.
const express = require('express');
const bodyParser= require('body-parser')
var cors = require('cors')
const mongodb = require('mongodb')
var db
const dbname = 'user';
const url = 'mongodb://user:pass@172.20.44.25/user';
const app = express();
app.use(cors({origin:{dotAll:true}}))
app.use('/client', express.static('public'))
app.use(bodyParser.json());
app.use(bodyParser.urlencoded({extended: true}))
mongodb.MongoClient.connect(url, function(err, client) {
if (err) return console.log(err)
db = client.db(dbname);
console.log('Connect OK');
})
app.listen(<port>,function() {
console.log('listening on <port>')
})
app.get('/', function(req,res) {
res.send('Aplikacja CRUD - node.js')
})
app.post('/stud', function( req,res ) {
console.log(JSON.stringify(req.body))
db.collection('student').insertOne(req.body,function(err,result) {
if (err) return console.log(err)
console.log('Rekord dodany do bazy')
res.end('{"inserted record":"'+result.insertedCount+'"}')
})
})
app.get('/stud', function(req, res) {
var cursor = db.collection('student').find().toArray(function(err, results) {
if (err) return console.log(err)
res.end(JSON.stringify(results))
console.log(results)
})
})
app.get('/stud/:id', function(req,res) {
console.log(req.params.id)
console.log(req.query)
if ( req.query.flag && req.query.flag == 1 ) {
db.collection('student').findOne({ident: req.params.id },function(err,result) {
if (err) return console.log(err)
res.end(JSON.stringify(result))
console.log(result)
})
} else {
db.collection('student').findOne({_id: new mongodb.ObjectId(req.params.id)},function(err,result) {
if (err) return console.log(err)
res.end(JSON.stringify(result))
console.log(result)
})
}
})
app.delete('/stud/:id',function(req, res) {
console.log(req.params.id)
console.log(req.query)
if ( req.query.flag && req.query.flag == 1 ) {
db.collection('student').findOne({ident: req.params.id },function(err,result) {
if (err) return console.log(err)
res.end(JSON.stringify(result))
console.log(result)
})
} else {
db.collection('student').deleteOne({_id: new mongodb.ObjectId(req.params.id)},function(err,result) {
if (err) return console.log(err)
console.log('Rekord usuniety z bazy - '+req.params.id)
res.end('{"Documents deleted ":"1"}')
})
}
})
app.put('/stud/:id',function(req,res) {
console.log(req.params.id)
console.log(req.query)
console.log(req.body)
data = req.body
if ( req.query.flag && req.query.flag == 1 ) {
db.collection('student').findOne({ident: req.params.id },function(err,result) {
if (err) return console.log(err)
res.end(JSON.stringify(result))
console.log(result)
})
} else {
db.collection('student').updateOne({_id: new mongodb.ObjectId(req.params.id)},{ $set: data}, function(err,result) {
if (err) return console.log(err)
console.log('rekord poprawiony - '+req.params.id)
console.log( result.modifiedCount )
console.log( result.matchedCount )
res.end('{"Document updated ":"'+result.modifiedCount+'"}')
})
}
})
Poprawność działania serwera sprawdzimy wykorzystując klinta serwisu REST opracowanego w poprzednim punkcie. Wymagana jest tylko modyfikacja
punktów końcowych w ramach klienta.
Serwis RESTful - python, Flask
Realizacja projektu jest zrealizowana w środowisku Python Virtual Environment.
W tym celu należy utworzyć odpowiedni katalog, przygotować środowisko
i pobrać odpowiednie pakiety do realizacji zadania. Poniżej przykładowa realizacja PVE wraz z poleceniami
przygotowującymi środowisko uruchomieniowe dla serwera.
from flask import Flask, jsonify, request, Response
from flask_pymongo import PyMongo
import json
from typing import Any
from bson.json_util import dumps
from bson import ObjectId
from flask_cors import CORS
class MongoJSONEncoder(json.JSONEncoder):
def default(self, o: Any) -> Any:
if isinstance(o, ObjectId):
return str(o)
if isinstance(o, datetime):
return str(o)
return json.JSONEncoder.default(self, o)
app = Flask(__name__, static_url_path='/client')
CORS(app)
app.config["MONGO_URI"] = "mongodb://user:pass2022@172.20.44.25:27017/user"
mongo = PyMongo(app)
@app.route('/stud', methods=['GET'])
def get_stud():
output = []
cursor = mongo.db.student.find()
data_json = MongoJSONEncoder().encode(list(cursor))
return data_json
@app.route('/stud', methods=['POST'])
def add_stud():
data = request.json
mongo.db.student.insert_one(data)
return {'result': 'ok'}, 200
@app.route('/stud/<id>', methods=['PUT'])
def update_stud(id):
objId = ObjectId(id)
data = request.json
query = { "_id" : objId }
value = { "$set" : data }
mongo.db.student.update_one(query, value)
return {'result':'OK'}, 200
@app.route('/stud/<id>', methods=['DELETE'])
def delete_stud(id):
objId = ObjectId(id)
query = { "_id" : objId }
mongo.db.student.delete_one(query)
return {'result':'OK'}, 200
if __name__ == '__main__':
app.run(host='149.156.109.180', port=<port>)
Poprawność działania serwera sprawdzimy wykorzystując klinta serwisu REST opracowanego w poprzednich punktach. Wymagana jest tylko modyfikacja
punktów końcowych w ramach klienta.
Linki do uruchomionych przykładów na serwerze Pascal
Linki dostępne z sieci wydziałowej.
Linki do dodatkowych materiałów (dostęp na dzień 6.01.2025)
