Записки о Mojolicious @mojolicioru - Tumblr Blog

Пробуем OpenAPI + Mojolicious

В определенный момент при развитии API приложения приходишь к мысли о миграции на OpenAPI. И вот я подошел к такому же моменту “прозрения” :-D. Хочется удобного инструмента, и swagger кажется то что нужно. Но разобраться в том как это запускать и работать с ним не так чтобы совсем просто (впрочем и не сложно). Пишу этот пост для того чтобы документрировать свое продвижение по этому вопросу.

Итак, берем наш ящик с инструментами. В нем у нас Mojolicious и Mojolicious::Plugin::OpenAPI . Последний поставился у меня с 10-го раза, т.к. почему-то зависимости от JSON::Validator так просто не сработали. Но все же установился.

Генерим простую app у

mojo generate app SimpleAPI

Я люблю конфиг держать в JSON, таким образом его удобнее шарить между другими частями системы, поэтому мой startup получается такой:

sub startup { my $self = shift;

my $config = $self->plugin('JSONConfig');

$self->secrets($config->{secrets});

# Router my $r = $self->routes; $r->get('/')->to('Pets#welcome'); $self->plugin("OpenAPI" => {url => $self->home->rel_file("json/myapi.json")}); }

Я подключил спецификацию из файла json/myapi.json .

Он у меня почти из документации скопипачен

{ "swagger": "2.0", "info": { "version": "1.0", "title": "Some awesome API" }, "basePath": "/api", "paths": { "/pets": { "get": { "operationId": "getPets", "x-mojo-name": "get_pets", "x-mojo-to": "pets#list", "summary": "Finds pets in the system", "parameters": [ {"in": "query", "name": "age", "type": "integer"} ], "responses": { "200": { "description": "Pet response", "schema": { "type": "object", "properties": { "pets": { "type": "array", "items": { "type": "object" } } } } } } } } } }

Тут уже нужно курить ман по спецификации OpenAPI, на первом этапе нам важно знать как определить роут и контроллер. За это отвечают следующие опции:

basePath - за этим роутом лежит наш апи.

"paths": { "/pets" - это роут, к нему обращатся так: localhost:3000/api/pets

"x-mojo-to": "pets#list", - это указание на контроллер Pets.pm и метод list

В контроллере:

sub list { my $c = shift->openapi->valid_input or return;

my $spec = $c->openapi->spec;

my $input = $c->validation->output; # $output will be validated by the OpenAPI spec before rendered

my $output = {description => "kit-e-cat", age => $input->{age} }; $c->render(openapi => $output);

}

Вот пока и все. Но что мы уже имеем. Самое главное - это

1. Документация по методам (в спецификации)

2. Валидация ввода. Т.е. в нашем примере при обращении по урлу:

http://127.0.0.1:3000/api/pets?age=123

получим

{"age":123,"descriptionzz":"kit-e-cat"}

А если мы запросим не integer

http://127.0.0.1:3000/api/pets?age=qwe

то уже

{"errors":[{"message":"Expected integer - got string.","path":"\/age"}],"status":400}

И это прекрасно :). Дальше постараюсь рассказать об авторизации и построении SPA приложения на базе Vue.js

#openapi #swagger #perl #mojolicious

DBIx::Custom модели

Кратенькая инструкция по моделям в DBIx::Custom

В основном скрипте:

use DBIx::Custom; use MyModel;

Подключаем модель (файл MyModel.pm и все вложенные модели в MyModel/books.pm , MyModel/users.pm, ...)

my $dbi = DBIx::Custom->connect( dsn => 'DBI:mysql:database=my_database;host=localhost;', user => 'user', password => 'password', connector => 1 );

my $dbi = MyModel->new($dbi);

my $models = $dbi->dbi->include_model('MyModel');

Объект конкретной модели:

my $mc_users = $dbi->dbi->model('users');

Вызываем кастомный select

my $emails = $mc_users->select(column => ['email']);

Файл MyModel.pm

package MyModel; use DBIx::Custom::Model -base;

# при обращении к Class->dbi вернуть хэндлер has dbi => sub { shift->{dbi} };

sub new { my $class = shift; my $dbi = shift;

my $self = { dbi => $dbi };

bless $self, $class; }

Файл MyModel/mc_users.pm

package MyModel::mc_users;

use lib qw(..); use Data::Dumper; use common::sense; use MyModel -base;

sub new { my $class = shift; my $self = { table => 'mc_users', class => $class, name => 'users' }; bless $self, $class; }

# кастомный метод

sub select { my $self = shift; my @args = @_; say Dumper(@args); return 1; }

#dbix-custom #dbix-custom-model #models

tips: Mojolicious конфиги

Всем привет!

Так как на статьи времени нет, то решил время от времени постить маленькие tips для Mojolicious.

#tips: Конфиг для приложения

С нуля сгенеренное приложение командой

$ mojo generate app Myexamp

Создает метод startup такого вида:

sub startup { my $self = shift;

# Documentation browser under "/perldoc" $self->plugin('PODRenderer');

# Router my $r = $self->routes;

# Normal route to controller $r->get('/')->to('example#welcome'); }

Для начала сделаем ряд важных изменений в startup прежде чем приступим к написанию своего приложения - Вместо $self->plugin('PODRenderer') подключим плагин для конфигурирования

$self->plugin('Config');

- укажем свои ключи для подписывания cookie

$self->secrets($self->config('secrets'));

Пока все, теперь вкратце что мы сделали.

Плагин Config автоматом пытается прочитать в корневой папке нашего приложения файл с именем my_examp.conf Сейчас его нет и запущенное через morbo так:

$morbo script/my_examp

наше приложение выдаст в лог что-то вроде

Can't load application from file ... Configuration file ..../my_examp.conf" missing, maybe you need to create it?

Так что создадим этот файл и сразу укажем в нем наши secrets, к которым мы уже обращаемся в следующей строке $self->secrets($self->config('secrets')) Как вы поняли - после подключения плагина Config - у нас становится доступен метод $self->config(), которому можно передавать имя ключа для выборки, и он вернет его значение.

В файле my_examp.conf напишем следующее:

{ secrets => ['mySuperSecrets1'] }

Этим ключом будут подписываться куки клиентов. Почему здесь массив? В старых версиях метод назывался secret и получал 1 значение, теперь это изменили. Почитать можно здесь

#mojolicious #tips #config

Hypnotoad нюанс

В формате шпаргалки:

Важным момент из конфига hypnotoad:

https://metacpan.org/pod/Mojo::Server::Hypnotoad#requests

Number of keep-alive requests per connection, defaults to the value of "max_requests" in Mojo::Server::Daemon.

Mojo по умолчанию для коннектов HTTP v1.1 считает их keep_alive (для 1.0 - это опционально). Я долго пытался понять как регулировать этот вопрос из кода (метод kept_alive у tx лишь флаг для проверки, а откуда ноги растут у этого соединения сразу не понял). Так вот за кол-во “живых” соединений на коннект отвечает этот параметр.

#mojolicious #mojo #websockets #hypnotoad

Git шпаргалки

https://github.com/git-tips/tips/blob/master/README.md

#git

Must read

Всем читать:

https://www.postgresql.org/docs/9.4/static/plperl-funcs.html

#perl #postgresql

На память оставлю это здесь

# Longer version my $req = $c->tx->req; # Extract request information my $url = $c->req->url->to_abs; my $info = $c->req->url->to_abs->userinfo; my $host = $c->req->url->to_abs->host; my $agent = $c->req->headers->user_agent; my $custom = $c->req->headers->header('Custom-Header'); my $bytes = $c->req->body; my $str = $c->req->text; my $hash = $c->req->params->to_hash; my $value = $c->req->json; my $foo = $c->req->json('/23/foo'); my $dom = $c->req->dom; my $bar = $c->req->dom('div.bar')->first->text;

#mojolicious #mojo #controller

Mojolicious::Plugin::QuickMy

Выложил плагин также и для MySQL, он аналогичен QuickPg и соответственно является хэлпером для Mojo::mysql

Mojolicious::Plugin::QuickMy

#mojolicious #perl #plugin #mysql

Mojolicious::Plugin::QuickPg

Сегодня наконец-то дошли руки дооформить давно используемый плагин в CPAN модуль https://metacpan.org/pod/Mojolicious::Plugin::QuickPg

Те кто работает с Mojo::Pg полагаю оценят его плюсы - бысрые запросы select, insert, update, delete, count - теперь писать меньше кода :), ну а если все же есть что-то что не вписывается в обычный select - можно использовать кастомные запросы с методом qcustom. В дистрибутиве есть исчерпывающие примеры приложений с Mojolicious::Lite и Mojolicious, но всегда можно спросить тут ;)

#mojolicious #perl #postgresql #mojo #plugin

Полезное о Perl

Просто пусть полежит здесь: http://eax.me/perl-hacks/

#perl #hacks

Mojolicious under route

У меня была переписка на ЖЖ в сообществе ru_perl которая в итоге привела к обсуждению метда under в Mojolicious. Делюсь здесь тем что туда написал:

“Смысл в том что чтобы выполнить роут в $client (достич его) нужно выполнить условие прописанное в under. Но в реальности конечно есть нюансы (например обязательный возврат return 0 даже если идет редирект, при этом в связке redirect_to and return - в противном случае все равно выполняется sub protected. https://bitbucket.org/pkuptsov/mojolicious_under/ ”

#mojolicious #authorisation

Trending Blogs

Recently Viewed Blogs

Записки о Mojolicious