Как создать API в Laravel для начинающих

В этом уроке по Laravel мы узнаем, как создать API в Laravel для начинающих. Создание API в Laravel — это искусство. Вы должны подумать о доступе к данным и обернуть свои модели Eloquent в конечные точки API.

Первое, что вам нужно сделать, это спроектировать свой API; Лучший способ сделать это — подумать о цели вашего API. Почему вы создаете этот API и каков целевой вариант использования? Как только вы это поймете, вы сможете эффективно разрабатывать свой API на основе того, как API интегрирован.

Сосредоточившись на своем видении того, как ваш API будет интегрирован, вы сможете устранить любые потенциальные недостатки в вашем API до его выпуска. Вот почему я всегда интегрирую и тестирую любой API, который я создаю, чтобы убедиться, что плавная интеграция охватывает все варианты использования, которые я намереваюсь использовать.

Давайте поговорим на примере, чтобы нарисовать картину. Я строю новый банк, Ларакойн. Мне нужно, чтобы мои пользователи могли создавать учетные записи и создавать транзакции для этих учетных записей. У меня есть шаблон учетной записи , шаблон транзакции и шаблон поставщика , которому должна принадлежать каждая транзакция. Примером этого является:

Account -> Has Many -> Transaction -> Belongs To -> Vendor
 
Spending Account -> Lunch 11.50 -> Some Restaurant

Итак, у нас есть три основные модели, на которых нам нужно сосредоточиться в нашем API. Если бы мы подошли к этой проблеме без какого-либо проектно-ориентированного мышления, мы создали бы следующие дорожные карты:

GET /accounts
POST /accounts
GET /accounts/{account}
PUT|PATCH /accounts/{account}
DELETE /accounts/{account}
 
GET /transactions
POST /transactions
GET /transactions/{transaction}
PUT|PATCH /transactions/{transaction}
DELETE /transactions/{transaction}
 
GET /vendors
POST /vendors
GET /vendors/{vendor}
PUT|PATCH /vendors/{vendor}
DELETE /vendors/{vendor}

Однако в чем преимущества этих маршрутов? Мы просто создаем JSON-доступ к нашим красноречивым моделям, который работает, но не добавляет ценности и с точки зрения интеграции делает все очень механическим.

Вместо этого подумайте о дизайне и назначении нашего API. Доступ к нашему API, скорее всего, будет осуществляться главным образом внутренними веб-приложениями и мобильными приложениями. Давайте сосредоточимся на этих вариантах использования, чтобы начать. Зная это, мы можем адаптировать наш API к пути пользователя в нашем приложении. Обычно в этих приложениях мы видим список учетных записей, чтобы мы могли управлять своими учетными записями. Нам также нужно будет нажать на учетную запись, чтобы увидеть список транзакций. Затем нам нужно будет нажать на транзакцию, чтобы увидеть более подробную информацию. На самом деле, нам никогда не придется встречаться с нашими поставщиками лично, поскольку у них есть больше возможностей для классификации, чем что-либо еще. С этим в мыслях,

GET /accounts
POST /accounts
GET /accounts/{account}
PUT|PATCH /accounts/{account}
DELETE /accounts/{account}
 
GET /accounts/{account}/transactions
GET /accounts/{account}/transactions/{transaction}
 
POST /transactions

Это позволит нам эффективно управлять нашей учетной записью и иметь возможность получать транзакции только непосредственно через вашу учетную запись. Мы не хотим, чтобы транзакции редактировались или управлялись прямо сейчас. Их просто нужно создать, а оттуда внутренний процесс должен обновить их, если это необходимо.

Теперь, когда мы знаем, как спроектировать наш API, мы можем сосредоточиться на том, как его построить, чтобы он быстро реагировал и масштабировался по мере сложности.

Во-первых, давайте предположим, что мы создаем приложение Laravel только для API, поэтому нам не понадобятся префиксы API. Подумайте о том, как мы можем зарегистрировать эти маршруты, так как обычно это первая часть вашего приложения, которая дает сбой. Разбор загруженного файла маршрута сложен, а когнитивная загрузка — первая битва в любом приложении.

Если бы этот API был обнародован, я бы нашел способ поддерживать API с версиями, и в этом случае я бы создал каталог версий и сохранил каждую основную группу в отдельном файле. Однако в данном случае мы не используем контроль версий, поэтому давайте упорядочим их по-другому.

Первый файл маршрутизации, который мы хотим создать, это route/api/accounts.php , мы можем добавить его в наш route/api.php .

Route::prefix('accounts')->as('accounts:')->middleware(['auth:sanctum', 'verified'])->group(
    base_path('routes/api/accounts.php),
);

Каждое ведро будет загружать свои маршруты, настраивать префикс промежуточного программного обеспечения по умолчанию и шаблон именования маршрутов. Наш файл маршрута для учетных записей будет плоским с минимальной кластеризацией, если только мы не хотим учитывать подресурсы. Это позволяет нам иметь только одну область для просмотра при попытке понять сами маршруты, но это означает, что все, что связано с учетной записью, будет принадлежать этому файлу.

Route::get(
    '/',
    App\Http\Controllers\Accounts\IndexController::class,
)->name('index');

Наша первая дорожная карта — это маршрут индексации учетных записей, который покажет все учетные записи аутентифицированным пользователям. Это, вероятно, первое, что вызывается через API, кроме маршрутов аутентификации, поэтому я обычно сосредотачиваюсь на этом в первую очередь. Сначала важно рассмотреть наиболее важные пути к разблокировке других пулов, но это также позволит вам углубиться в стандарты, которым вы хотите следовать в своем приложении.

Теперь, когда мы понимаем, как маршрутизировать наши запросы, мы можем подумать о том, как мы хотим обрабатывать эти запросы. Где логика и как сделать так, чтобы дублирование кода было минимальным?

Недавно я написал руководство по эффективному использованию Eloquent , которое углубляется в слои запросов. Это мой предпочтительный подход, поскольку он гарантирует, что у нас будет минимальное количество повторяющегося кода. Я не буду вдаваться в подробности о том, почему я буду использовать этот метод, так как я подробно описал это в предыдущем уроке. Тем не менее, я объясню, как использовать его в вашем приложении. Вы можете использовать этот метод, если он соответствует вашим потребностям.

Самое важное, что нужно помнить, это то, что лучший способ получить максимальную отдачу от вашего API — это построить его таким образом, чтобы он работал для вас и вашей команды. Если вы потратите часы, пытаясь приспособиться к неестественному методу, это только замедлит вас и не принесет той пользы, которую вы пытаетесь достичь.

При создании класса запроса необходимо привязать соответствующий интерфейс к контроллеру. Это не обязательный шаг. Тем не менее, я автор учебников — так чего же вы на самом деле ожидаете?

interface FilterForUserContract
{
    public function handle(Builder $query, string $user): Builder;
}

Итак, реализация, которую мы хотим использовать:

final class FilterAccountsForUser implements FilterForUserContract
{
    public function handle(Builder $query, string $user): Builder
    {
        return QueryBuilder::for(
            subject: $query,
        )->allowedIncludes(
            include: ['transactions'],
        )->where('user_id', $user)->getEloquentBuilder();
    }
}

Этот класс запроса получит все учетные записи для переданных пользователей, давая вам возможность добавлять транзакции для каждой учетной записи, а затем возвращать красноречивый конструктор, чтобы добавить дополнительную область по мере необходимости.

Мы можем использовать это в нашем контроллере, чтобы запрашивать учетные записи пользователей, прошедших проверку подлинности, и возвращать их в нашем ответе. Давайте посмотрим, как мы можем использовать этот запрос, чтобы понять доступные параметры.

final class IndexController
{
    public function __construct(
        private readonly Authenticatable $user,
        private readonly FilterForUserContract $query,
    ) {}
 
    public function __invoke(Request $request): Responsable
    {
        $accounts = $this->query->handle(
            query: Account::query()->latest(),
            user: $this->user->getAuthIdentifier(),
        );
 
        // return response here.
    }
}

На данный момент наш контроллер имеет красноречивый конструктор, который будет передавать ответ, поэтому при передаче данных не забудьте вызвать get или paginate для передачи правильных данных. Это подводит нас к следующему пункту в моем путешествии в перспективу.

Обратная связь является основной обязанностью нашего API. Мы должны реагировать быстро и эффективно, чтобы наши пользователи могли пользоваться быстрым и отзывчивым API. То, как мы отвечаем как API, можно разделить на две области: уровень ответа и способ преобразования данных для ответа.

Этими двумя областями являются ответы и ресурсы API. Начну с возможностей API, так как они меня очень интересуют. Функции API используются для запутывания структуры базы данных и способа преобразования информации, хранящейся в вашем API, таким образом, чтобы ее лучше использовать на стороне клиента.

Я использую шаблоны JSON:API в своих API Laravel, потому что это отличный шаблон, который хорошо задокументирован и используется в сообществе API. К счастью, Тим Макдональд создал отличный пакет для создания ресурсов JSON:API в Laravel, который я клянусь использовать во всех своих приложениях Laravel. Недавно я написал учебник о том, как использовать этот пакет, поэтому я просто расскажу здесь о некоторых деталях.

Начнем с ресурса учетной записи, который будет настроен на наличие связанных отношений и свойств. Со времени моего последнего урока этот пакет был недавно обновлен, что упрощает установление отношений.

final class AccountResource extends JsonApiResource
{
    public $relationships = [
        'transactions' => TransactionResource::class,
    ];
 
    public function toAttributes(Request $request): array
    {
        return [
            'name' => $this->name,
            'balance' => $this->balance->getAmount(),
        ];
    }
}

Пока что мы делаем это очень просто. Мы хотим вернуть имя и баланс учетной записи с возможностью загрузки их в транзакционные отношения.

Использование этих функций означает доступ к имени, и мы должны использовать: data.attributes.name , может потребоваться некоторое время, чтобы привыкнуть к вашему веб-приложению или мобильному приложению, но вы скоро освоитесь. Мне нравится этот подход, потому что мы можем разделить отношения и атрибуты и расширить их по мере необходимости.

Как только наши ресурсы заполнены, мы можем сосредоточиться на других областях, таких как авторизация. Это важная часть нашего API, и ее нельзя упускать из виду. Большинство из нас использовали Laravels Gate раньше, используя Gate Facade. Однако я хочу выполнить контракт Gateway из самого фреймворка. Это в основном потому, что я предпочитаю внедрение зависимостей фасада, когда предоставляется такая возможность. Давайте посмотрим, как это может выглядеть в StoreController для учетных записей.

final class StoreController
{
    public function __construct(
        private readonly Gate $access,
    ) {}
 
    public function __invoke(StoreRequest $request): Responsable
    {
        if (! $this->access->allows('store')) {
            // respond with an error.
        }
 
        // the rest of the controller goes here.
    }
}

Здесь мы просто используем функцию Gate в качестве фасада, так как они одинаковые. Я использую здесь allow , но вы можете использовать can или другие методы. Вы должны сосредоточиться на делегировании на том, как оно реализовано, так как это небольшая деталь для вашего приложения в конце дня.

Итак, мы знаем, как мы хотим, чтобы данные были представлены в API, и как мы хотим авторизовать пользователей в приложении. Далее мы можем увидеть, как мы можем обрабатывать операции записи.

Когда дело доходит до нашего API, операции записи очень важны. Нам нужно убедиться, что они работают быстро, чтобы наш API работал быстро.

Вы можете записывать данные в свой API различными способами, но я предпочитаю использовать фоновые задания и быстро выполнять откат. Это означает, что вы можете беспокоиться о логике создания вещей в свое время, а не время клиента. Преимущество заключается в том, что ваши фоновые задания по-прежнему могут публиковать обновления через веб-сокеты для ощущения реального времени.

Взгляните на обновленный StoreController для учетных записей при использовании этого метода:

final class StoreController
{
    public function __construct(
        private readonly Gate $access,
        private readonly Authenticatable $user,
    ) {}
 
    public function __invoke(StoreRequest $request): Responsable
    {
        if (! $this->access->allows('store')) {
            // respond with an error.
        }
 
        dispatch(new CreateAccount(
            payload: NewAccount::from($request->validated()),
            user: $this->user->getAuthIdentifier(),
        ));
 
        // the rest of the controller goes here.
    }
}

Мы отправляем нашему фоновому заданию полезную нагрузку объекта передачи данных, который будет последовательно поставлен в очередь. Мы создали этот DTO, используя аутентифицированные данные, и мы хотим отправить его через идентификатор пользователя, потому что нам нужно знать, кто это будет делать.

В этом подходе у нас есть действительные данные и безопасный тип, переданный в модель. В наших тестах все, что нам нужно было сделать, это убедиться, что задание отправлено.

it('dispatches a background job for creation', function (string $string): void {
    Bus::fake();
 
    actingAs(User::factory()->create())->postJson(
        uri: action(StoreController::class),
        data: [
            'name' => $string,
        ],
    )->assertStatus(
        status: Http::ACCEPTED->value,
    );
 
    Bus::assertDispatched(CreateAccount::class);
})->with('strings');

Мы тестируем здесь, чтобы убедиться, что мы проходим процесс проверки, получаем правильный код состояния из нашего API, а затем подтверждаем, что была отправлена правильная фоновая работа.

Затем мы можем протестировать задание отдельно, так как его не нужно включать в наше тестирование конечной точки. Теперь, как это будет записано в базу данных? Мы используем класс Command для записи наших данных. Я использую этот метод, потому что использование только классов Action может привести к путанице. В итоге мы получили сотни акций, которые было трудно проанализировать при поиске конкретной акции в нашем каталоге.

Как всегда, мне нравится использовать Dependency Injection, нам нужно создать интерфейс, который мы будем использовать для работы с нашей реализацией.

interface CreateNewAccountContract
{
    public function handle(NewAccount $payload, string $user): Model;
}

Мы используем DTO новой учетной записи в качестве полезной нагрузки и передаем идентификатор пользователя в виде строки. Обычно я даю это как строку; Я буду использовать UUID или ULID для поля ID в своем приложении.

final class CreateNewAccount implements CreateNewAccountContract
{
    public function handle(NewAccount $payload, string $user): Model
    {
        return DB::transaction(
            callback: fn (): Model => Account::query()->create(
                    attributes: [
                        ...$payload->toArray(),
                        'user_id' => $user,
                ],
            ),
        );
    }
}

Мы заключаем наше действие записи в транзакцию базы данных, поэтому мы фиксируемся в базе данных только в случае успешной записи. Это позволяет нам откатиться и выдать исключение, если запись не удалась.

Мы рассмотрели, как преобразовать данные модели для нашего ответа, как запрашивать и записывать данные и как мы хотим авторизовать пользователей в приложении. Заключительный этап создания надежного API в Laravel — посмотреть, как мы реагируем как API.

Большинство API плохо реагируют. Это иронично, так как это, вероятно, самая важная часть API. В Laravel есть много способов ответа, от использования вспомогательных функций до возврата новых экземпляров JsonResponse . Однако я хочу создать специальные классы Response. Они похожи на классы Query и Command, целью которых является сокращение дублирования кода, но они также являются наиболее предсказуемым способом возврата ответа.

Первый ответ, который я создаю, — это ответ коллекции, который я буду использовать при возврате списка учетных записей, принадлежащих пользователям, прошедшим проверку подлинности. Я также сделаю набор других ответов, от ответов с одной моделью до пустых ответов и ответов с ошибками.

class Response implements Responsable
{
    public function toResponse(): JsonResponse
    {
        return new JsonResponse(
            data: $this->data,
            status: $this->status->value,
        );
    }
}

Сначала мы должны создать начальный ответ, который будут расширять наши классы ответов. Это потому, что все они будут реагировать одинаково. Все они должны возвращать данные и код состояния — одинаково. Итак, теперь давайте посмотрим на сам класс ответа коллекции.

final class CollectionResponse extends Response
{
    public function __construct(
        private readonly JsonApiResourceCollection $data,
        private readonly Http $status = Http::OK,
    ) {}
}

Это очень очевидно и легко сделать в будущем, и вы можете сделать атрибут данных составным типом для большей гибкости.

final class CollectionResponse extends Response
{
    public function __construct(
        private readonly Collection|JsonResource|JsonApiResourceCollection $data,
        private readonly Http $status = Http::OK,
    ) {}
}

Они понятны и просты для понимания, поэтому давайте посмотрим на окончательную реализацию IndexController для учетных записей.

final class IndexController
{
    public function __construct(
        private readonly Authenticatable $user,
        private readonly FilterForUserContract $query,
    ) {}
 
    public function __invoke(Request $request): Responsable
    {
        $accounts = $this->query->handle(
            query: Account::query()->latest(),
            user: $this->user->getAuthIdentifier(),
        );
 
        return new CollectionResponse(
            data: $accounts->paginate(),
        );
    }
}

Сосредоточение внимания на этих критических областях позволяет масштабировать сложность вашего API, не беспокоясь о дублировании кода. Это основные области, на которых я всегда буду фокусироваться, пытаясь выяснить, что вызывает замедление работы Laravel API.

Это ни в коем случае не исчерпывающее руководство или список того, на чем вам нужно сосредоточиться, но, следуя этому довольно краткому руководству, вы можете подготовиться к будущему успеху.

Оригинальный источник статьи: https://laravel-news.com

#laravel #api

What is GEEK

Buddha Community

Как создать API в Laravel для начинающих

I am Developer

1595240610

Laravel 7 File Upload Via API Example From Scratch

Laravel 7 file/image upload via API using postman example tutorial. Here, you will learn how to upload files/images via API using postman in laravel app.

As well as you can upload images via API using postman in laravel apps and also you can upload images via api using ajax in laravel apps.

If you work with laravel apis and want to upload files or images using postman or ajax. And also want to validate files or images before uploading to server via API or ajax in laravel.

So this tutorial will guide you step by step on how to upload file vie API using postman and ajax in laravel with validation.

Laravel Image Upload Via API Using Postman Example

File

Follow the below given following steps and upload file vie apis using postman with validation in laravel apps:

Step 1: Install Laravel New App
Step 2: Add Database Credentials
Step 3: Generate Migration & Model
Step 4: Create Routes For File
Step 5: Generate Controller by Artisan
Step 6: Run Development Server
Step 7: Laravel Upload File Via Api Using PostMan

Checkout Full Article here https://www.tutsmake.com/laravel-file-upload-via-api-example-from-scratch/

#uploading files via laravel api #laravel file upload api using postman #laravel image upload via api #upload image using laravel api #image upload api in laravel validation #laravel send file to api

Domingo Jakubowski

1595396220

Top 10 API Security Threats Every API Team Should Know

As more and more data is exposed via APIs either as API-first companies or for the explosion of single page apps/JAMStack, API security can no longer be an afterthought. The hard part about APIs is that it provides direct access to large amounts of data while bypassing browser precautions. Instead of worrying about SQL injection and XSS issues, you should be concerned about the bad actor who was able to paginate through all your customer records and their data.

Typical prevention mechanisms like Captchas and browser fingerprinting won’t work since APIs by design need to handle a very large number of API accesses even by a single customer. So where do you start? The first thing is to put yourself in the shoes of a hacker and then instrument your APIs to detect and block common attacks along with unknown unknowns for zero-day exploits. Some of these are on the OWASP Security API list, but not all.

Insecure pagination and resource limits

Most APIs provide access to resources that are lists of entities such as /users or /widgets. A client such as a browser would typically filter and paginate through this list to limit the number items returned to a client like so:

First Call: GET /items?skip=0&take=10 
Second Call: GET /items?skip=10&take=10

However, if that entity has any PII or other information, then a hacker could scrape that endpoint to get a dump of all entities in your database. This could be most dangerous if those entities accidently exposed PII or other sensitive information, but could also be dangerous in providing competitors or others with adoption and usage stats for your business or provide scammers with a way to get large email lists. See how Venmo data was scraped

A naive protection mechanism would be to check the take count and throw an error if greater than 100 or 1000. The problem with this is two-fold:

For data APIs, legitimate customers may need to fetch and sync a large number of records such as via cron jobs. Artificially small pagination limits can force your API to be very chatty decreasing overall throughput. Max limits are to ensure memory and scalability requirements are met (and prevent certain DDoS attacks), not to guarantee security.
This offers zero protection to a hacker that writes a simple script that sleeps a random delay between repeated accesses.

skip = 0
while True:    response = requests.post('https://api.acmeinc.com/widgets?take=10&skip=' + skip),                      headers={'Authorization': 'Bearer' + ' ' + sys.argv[1]})    print("Fetched 10 items")    sleep(randint(100,1000))    skip += 10

How to secure against pagination attacks

To secure against pagination attacks, you should track how many items of a single resource are accessed within a certain time period for each user or API key rather than just at the request level. By tracking API resource access at the user level, you can block a user or API key once they hit a threshold such as “touched 1,000,000 items in a one hour period”. This is dependent on your API use case and can even be dependent on their subscription with you. Like a Captcha, this can slow down the speed that a hacker can exploit your API, like a Captcha if they have to create a new user account manually to create a new API key.

Insecure API key generation

Most APIs are protected by some sort of API key or JWT (JSON Web Token). This provides a natural way to track and protect your API as API security tools can detect abnormal API behavior and block access to an API key automatically. However, hackers will want to outsmart these mechanisms by generating and using a large pool of API keys from a large number of users just like a web hacker would use a large pool of IP addresses to circumvent DDoS protection.

How to secure against API key pools

The easiest way to secure against these types of attacks is by requiring a human to sign up for your service and generate API keys. Bot traffic can be prevented with things like Captcha and 2-Factor Authentication. Unless there is a legitimate business case, new users who sign up for your service should not have the ability to generate API keys programmatically. Instead, only trusted customers should have the ability to generate API keys programmatically. Go one step further and ensure any anomaly detection for abnormal behavior is done at the user and account level, not just for each API key.

Accidental key exposure

APIs are used in a way that increases the probability credentials are leaked:

APIs are expected to be accessed over indefinite time periods, which increases the probability that a hacker obtains a valid API key that’s not expired. You save that API key in a server environment variable and forget about it. This is a drastic contrast to a user logging into an interactive website where the session expires after a short duration.
The consumer of an API has direct access to the credentials such as when debugging via Postman or CURL. It only takes a single developer to accidently copy/pastes the CURL command containing the API key into a public forum like in GitHub Issues or Stack Overflow.
API keys are usually bearer tokens without requiring any other identifying information. APIs cannot leverage things like one-time use tokens or 2-factor authentication.

If a key is exposed due to user error, one may think you as the API provider has any blame. However, security is all about reducing surface area and risk. Treat your customer data as if it’s your own and help them by adding guards that prevent accidental key exposure.

How to prevent accidental key exposure

The easiest way to prevent key exposure is by leveraging two tokens rather than one. A refresh token is stored as an environment variable and can only be used to generate short lived access tokens. Unlike the refresh token, these short lived tokens can access the resources, but are time limited such as in hours or days.

The customer will store the refresh token with other API keys. Then your SDK will generate access tokens on SDK init or when the last access token expires. If a CURL command gets pasted into a GitHub issue, then a hacker would need to use it within hours reducing the attack vector (unless it was the actual refresh token which is low probability)

Exposure to DDoS attacks

APIs open up entirely new business models where customers can access your API platform programmatically. However, this can make DDoS protection tricky. Most DDoS protection is designed to absorb and reject a large number of requests from bad actors during DDoS attacks but still need to let the good ones through. This requires fingerprinting the HTTP requests to check against what looks like bot traffic. This is much harder for API products as all traffic looks like bot traffic and is not coming from a browser where things like cookies are present.

Stopping DDoS attacks

The magical part about APIs is almost every access requires an API Key. If a request doesn’t have an API key, you can automatically reject it which is lightweight on your servers (Ensure authentication is short circuited very early before later middleware like request JSON parsing). So then how do you handle authenticated requests? The easiest is to leverage rate limit counters for each API key such as to handle X requests per minute and reject those above the threshold with a 429 HTTP response. There are a variety of algorithms to do this such as leaky bucket and fixed window counters.

Incorrect server security

APIs are no different than web servers when it comes to good server hygiene. Data can be leaked due to misconfigured SSL certificate or allowing non-HTTPS traffic. For modern applications, there is very little reason to accept non-HTTPS requests, but a customer could mistakenly issue a non HTTP request from their application or CURL exposing the API key. APIs do not have the protection of a browser so things like HSTS or redirect to HTTPS offer no protection.

How to ensure proper SSL

Test your SSL implementation over at Qualys SSL Test or similar tool. You should also block all non-HTTP requests which can be done within your load balancer. You should also remove any HTTP headers scrub any error messages that leak implementation details. If your API is used only by your own apps or can only be accessed server-side, then review Authoritative guide to Cross-Origin Resource Sharing for REST APIs

Incorrect caching headers

APIs provide access to dynamic data that’s scoped to each API key. Any caching implementation should have the ability to scope to an API key to prevent cross-pollution. Even if you don’t cache anything in your infrastructure, you could expose your customers to security holes. If a customer with a proxy server was using multiple API keys such as one for development and one for production, then they could see cross-pollinated data.

#api management #api security #api best practices #api providers #security analytics #api management policies #api access tokens #api access #api security risks #api access keys

Autumn Blick

1601381326

Public ASX100 APIs: The Essential List

We’ve conducted some initial research into the public APIs of the ASX100 because we regularly have conversations about what others are doing with their APIs and what best practices look like. Being able to point to good local examples and explain what is happening in Australia is a key part of this conversation.

Method

The method used for this initial research was to obtain a list of the ASX100 (as of 18 September 2020). Then work through each company looking at the following:

Whether the company had a public API: this was found by googling “[company name] API” and “[company name] API developer” and “[company name] developer portal”. Sometimes the company’s website was navigated or searched.
Some data points about the API were noted, such as the URL of the portal/documentation and the method they used to publish the API (portal, documentation, web page).
Observations were recorded that piqued the interest of the researchers (you will find these below).
Other notes were made to support future research.
You will find a summary of the data in the infographic below.

Data

With regards to how the APIs are shared:

Documentation is where just the Swagger/OpenAPI docs are hosted somewhere. e.g. https://api.linkgroup.com/member/docs/index
Portal is where an interactive portal has been developed. e.g. https://dev.telstra.com/
The web page is where the company has a single page that isn’t interactive explaining their Public APIs. e.g. https://www.bendigoadelaide.com.au/banking-products-api.asp

#api #api-development #api-analytics #apis #api-integration #api-testing #api-security #api-gateway

I am Developer

1602036957

Laravel 8 REST API Authentication with Passport Example Tutorial

Laravel 8 rest api authentication with passport tutorial, you will learn step by step how to create rest API with laravel 8 passport authentication. And as well as how to install and cofigure passport auth in laravel 8 app.

Laravel 8 API Authentication with Passport Tutorial

Step 1: Download Laravel 8 App
Step 2: Database Configuration
Step 3: Install Passport Auth
Step 4: Passport Configuration
Step 5: Run Migration
Step 6: Create APIs Route
Step 7: Create Passport Auth Controller
Step 8: Now Test Laravel REST API in Postman

https://www.tutsmake.com/laravel-8-rest-api-authentication-with-passport/

#laravel api authentication with passport #laravel 8 api authentication #laravel 8 api authentication token tutorial #laravel 8 api authentication using passport #laravel 8 api authentication session

‎Andres Gallo‎

1604399880

An API-First Approach For Designing Restful APIs | Hacker Noon

I’ve been working with Restful APIs for some time now and one thing that I love to do is to talk about APIs.

So, today I will show you how to build an API using the API-First approach and Design First with OpenAPI Specification.

First thing first, if you don’t know what’s an API-First approach means, it would be nice you stop reading this and check the blog post that I wrote to the Farfetchs blog where I explain everything that you need to know to start an API using API-First.

Preparing the ground

Before you get your hands dirty, let’s prepare the ground and understand the use case that will be developed.

Tools

If you desire to reproduce the examples that will be shown here, you will need some of those items below.

NodeJS
OpenAPI Specification
Text Editor (I’ll use VSCode)
Command Line

Use Case

To keep easy to understand, let’s use the Todo List App, it is a very common concept beyond the software development community.

#api #rest-api #openai #api-first-development #api-design #apis #restful-apis #restful-api