Flask-Mongorest. Frame de API RESTFUL FRASK para MongoDB / Mongoengine
Baixe Agora

Flask-Mongorest. Classificação e resumo

Flask-Mongorest. Tag

Biblioteca Python. Pitão MongoDB Mongoengine

Flask-Mongorest. Descrição

Flask-MongoRest é uma estrutura de API RESTFUS para MongoDB / Mongoengine.SetupFrom Flask FlaskFrom Flask.ext.mongoengine Import MongoengineFrom Flask.ext.mongorest ImportFrom flask.ext.mongorest.Views Importar ResourceViewFrom Flask.ext.mongorest.Resources Importar ResourceBrom .ext.Mongorest Operadores de importação como opsfrom flask.ext.mongorest métodos de importação app = flask (__ nome __) app.config.update (mongodb_host = 'localhost', mongodb_port = '27017', mongodb_db = 'mongorest_example_app',) db = mongo App) API = Mongorest (App) Classe User (DB.Document): Email = db.emailfield (exclusivo = TRUE, obrigatório = True) classe de classe (db.embeddeddocument): text = db.stringfield () classe contentresource (recurso) : document = ContentClass post (db.document): title = db.stringfield (max_length = 120, obrigatório = true) author = db.referencefield (usuário) conteúdo = db.embeddededocumentfield (conteúdo) classe postresource (recurso): documento = relacionado_resources = {'Conteúdo': ContentResource,} filtros = {'title': , 'Author_ID': ,} rename_fields = {'autor': 'author_id',} @ api.register (nome = 'posts', url = '/ posts /' ) Classe ViewView (ResourceView): recurso = métodos postresource = Com este aplicativo, os seguintes comandos de curl podem ser usados: Crie um post: Curl -h "Content- Tipo: Aplicativo / JSON "-X post -d \ '{" title ":" primeiro post! "," Author_id ":" autor_id_from_a_previous_api_call "," conteúdo ": {" Texto ":" Este é o nosso teste de teste "} } 'http://0.0.0.0.5000/posts/ {"ID": "1", "title": "primeiro post!", "Author_id": "autor_id_from_a_previous_api_call", "conteúdo": {"Texto": {"Texto": "Este é o nosso teste de teste"}} Obter um post: Curl http://0.0.0.0:5000/posts/1/ {"ID": "1", "Título": "Primeiro post!", "Author_ID ":" Authort_id_from_a_previous_api_call "," Content ": {" Texto ":" Este é o nosso teste de teste de teste "}} listar todas as postagens ou filtrar pelo título: Curl http http: ou curl http : //0.0.0.0: 5000 / posts /? Title__startswith = abeto St Post {"Data": } Excluir um post: Curl -x Excluir http://0.0.0.0:5000/poss.0.0:5000/posts/1/# Falha desde que a postview.methods não permite o deleterequest params_skip e _limit => utilizam As funções internas de MongoDB._Fields => Limite dos campos da resposta àqueles nomeados aqui (vírgula separados) ._ encomenda_by => Encomendar resultados Se esta string estiver presente no recurso.allowed_ordering list.resource configurationrename_fields => dito de renomear regras. Útil para mapear os campos _id, como "organização": "Organization_id" filtros => filtrar resultados de uma solicitação de lista usando os filtros permitidos que são usados como / usuário /? Id__gt = 2 ou /user/?email__exact=a@b.comrelated_resources => Serialização de recursos aninhada para campos de referência / incorporada de um documentchild_document_resources => Suponha que você tenha uma classe base de base que tenha subclasses masculinos e femininos. Essas subclasses e seus respectivos recursos compartilham a mesma coleção MongoDB, mas têm diferentes campos e características de serialização. Este dicionário permite mapear instâncias de classe para seus respectivos recursos a serem usados durante a serialização.Autenticação A classe AuthenticationBase fornece a capacidade de aplicação de aplicativos para implementar sua própria API AUTH. Dois padrões comuns são mostrados abaixo com um baseresourceview que pode ser usado como a visualização pai de todos os recursos do seu aplicativo.Class SessionAuthentication (AuthenticationBase): Def Autorizado (auto): Return Current_user.is_authenticated () Classe APIKEYAuthentication (AuthenticationBase): " "" @Todo apikey documento e geração de chave esquerda para a implementação específica "" Def autorizado (auto): se 'autorização' em solicitação.Headers: autorização = solicitação.Headers . Split () Se Len (Autorização ) == 2 e autorização .lower () == 'Basic': tente: autorização_parts = base64.b64decode (autorização ). Partição (':') Key = smart_unicode (Autorization_Parts ) API_KEY = Apikey.objects.get (key__exact = key) Se API_KEY.USER: LOGIN_USER (API_KEY.USER) Setattr (API_KEYER, 'API_KEY', API_KEY) Retornar true exceto (TypeError, UnicodeDecodeError, APIKEY.DOESNOTEXIST): Passagem de retorno Falseclass baseresourceView (ResourceView ): authentication_methods = A execução do pacote Test Suitethis usa nosetestes para testes automatizados. Basta executar o Python Setup.py nosetestes para executar os testes. Nenhuma configuração ou qualquer outro prep necessário.ContributributingPull Solicitações são muito apreciadas!

Flask-Mongorest. Software Relacionado