Game Development, 게임개발/게임네트워크

Postman Tutorial - 1 (사용 목적, UI)

게임이 더 좋아 2022. 7. 10. 09:55
반응형
728x170

 

우체부라는 뜻을 가진 Postman

https://www.postman.com/

 

Postman API Platform | Sign Up for Free

Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.

www.postman.com

 

왜 쓰는 것일까?

알아보자

 


 

Postman is an API platform for building and using APIs

Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster.

 

API 개발과 테스트를 손쉽게 할 수 있다고 한다.

특히 이번에 알고 가야할 것은  REST API로 배경지식으로 꼭 필요하다.

또한 명세서가 필요없다.

사실 필요는 있고.. 명세서 + 포스트맨이 최고의 조합이라고 생각한다.

 

API repository

Easily store, catalog, and collaborate around all your API artifacts on one central platform. Postman can store and manage API specifications, documentation, workflow recipes, test cases and results, metrics, and everything else related to APIs.

 

여러가지 협업 툴도 제공한다.

Tools

The Postman platform includes a comprehensive set of tools that help accelerate the API lifecycle—from design, testing, documentation, and mocking to the sharing and discoverability of your APIs.

 

그리고 똑똑하다.

Intelligence

The Postman platform gives you advanced intelligence and insights about all of your API operations by leveraging alerts and security warnings, search, reporting, and more.

 

또한 워크스페이스 별로 격리도 제공한다.

Workspaces

Postman workspaces help you organize your API work and collaborate across your organization or across the world. There are three different kinds of Postman workspaces for your different needs: personal workspaces, team workspaces, and public workspaces.

 

또한 협업에 특화된 만큼 통합기능도 제공한다.

Integrations

Postman integrates with the most important tools in your software development pipeline to enable API-first practices. The Postman platform is also extensible through the Postman API and through open source technologies.

 

 

뭐 모든 기능을 이용할 필요는 없다.

그리고 Postman 자체에서 이용할 필요도 없다.

그냥 이것은 하나의 도구고 저 사람이 이 기능을 제공하기 위해서 어떤 식으로 구현했구나

내가 구현하는 게 좋을까? 얘 그냥 쓰는게 좋을까? 생각하면서 그냥 쓰면 된다.

 


 

Postman이 제공한다는 공식적인 기능을 보면 아주 많다.

더보기

Making requests

If you're building a client app or want to connect to an API, check out some Postman essentials:

Testing APIs

If you're testing an API, you can use Postman to automate various parts of the process:

Building and managing APIs

If you're developing a back-end, working API-first, or need to monitor API performance, Postman utilities can streamline your workflows:

Publishing APIs

If you're exposing an API for public use, Postman can support developer onboarding:

Collaborating with your team

If you're using Postman in your company or team, check out these guides to maximize your collaboration:

Developing with Postman

If you're integrating Postman with your CI/CD workflow or are developing with Postman APIs or libraries, check out these resources:

 

내가 사용하는 주요 기능으로 몇가지 뽑아보자면

API 만들고 API Test 이다.

좀더 정확하게 말하자면 Request를 보내는 용도이자 테스트를 할 때 쓴다.

얘를 가지고 직접 뭔가를 하지는 않는다.

다만 명세서 + Postman을 쓰면 가독성이 완전 좋아진다.

 


 

하지만 먼저 이 기능을 사용하기 전에 Interface 를 봐야 한다.

내가 무엇이 어디에 있고 무엇을 할 수 있는지를 알아야 사용할 것이지 않은가.

**나한테 중요한 내용은 설명과 더불어 파란색으로 바꿔놓았다.

 

 

 

처음은 Header부터 보자.

대개 Header는 메뉴 바가 있다.

얘도 그렇다.

영어 설명으론 아래와 같다.

=> 어차피 Postman docs에 있는 내용이다.

 

더보기

The header enables you to create workspaces, access reports, explore the public API network, search in Postman, view sync status and notifications, and access your settings, account, and Postman plan.

  • Home - Go to your personal home page, which includes alerts, announcements, your activity feed, your recently visited workspaces, and links to resources for your team if applicable.
  • Workspaces - Search for workspaces, view your recently visited workspaces, or create a new workspace.

=> Workspaces가 하나의 단위다. 프로젝트 단위로 나눌 수 있다고 생각하면 된다.

 

=> 외부의 API를 쓸 수 있다. 다만 나의 경우는 많이 쓰지는 않는다.

 

  • Explore - Browse public APIs, teams, workspaces, and collections on Postman.
  •  Search Postman - Search all workspaces, collections, APIs, and teams in Postman. For more details on searching in Postman, see Search Postman.
  • Invite - If you have an Admin role on a workspace, you can invite other users to collaborate.
  •  
     Settings - Access Postman settings and other Postman resources.
  •  Notifications - View recent activity from your team, get notifications about Postman updates, and see pull requests, comment activity, and other important information.
  • Your avatar - View your profile, access your account and notification settings, see all active sessions for your account, or sign out of your account.
  • Team (paid plans) or Upgrade (free plan) - View resource usage and access your billing dashboard and other account management tools.

Search Postman

To search in Postman, select Search Postman in the header then enter your search terms. You can also use the keyboard shortcut ⌘+K or Ctrl+K. To change the scope of your search to your personal or team space or the Public API Network, select All of Postman and choose the desired scope. You can also change the scope of your search to Workspaces, Collections, APIs, or Teams.

For signed-out users, search results only include public resources.

If you don't find what you are looking for in the list of results, select Search all workspaces, collections, APIs and teams and you can find all the results in one page.

The Search results page lists the scope and element type. You can change these options to further filter your results.

You can also sort results using Sort by on the right by selecting Most relevant (default), Most views, or Most recent.

Depending on the element type, the search results contain different information:

  • For workspaces, the search result contains the workspace type, summary, who published it, and when was it published.
  • For collections, the search result contains the workspace type, whether the collection is a fork or not, who published it, and when was it published.
  • For APIs, the search result contains the name and summary of the API, the API's owner (either an individual user or a team), and the workspace type.
  • For teams, the search result contains the name and summary of the team. Selecting the team name redirects you to the team profile.

 

 

중요한 기능을 추려보자면

1. Workspace 만들기

2. API들 관리

그 외엔 기본적으로 무조건 알아야 한다는 것은 없다.

 

 

다음은 Sidebar이다.

 

영어는 이렇다.

 

아마 Sidebar를 제일 많이 쓰지 않을까 싶다.

실제 워크스페이스는 처음 설정에서만 들어가고 나머진 똑같으니까..?

 

더보기

The Postman sidebar provides access to the fundamental elements of Postman:

To see the task options that are available for elements in the sidebar, select the element's name then select the more options icon 

 .

The task options will vary depending on the type of element you've selected.

For collections, folders and requests inside a collection, and requests in History, you can select more than one element at a time. Press and hold ⌘ or Ctrl, then select the desired elements.

For elements that are next to each other, press and hold Shift, then select the desired elements.

For collections and their contents, you can also use keyboard shortcuts for tasks like copying, pasting, and deleting.

To hide the sidebar, select the hide sidebar icon 

 from the footer.

 

내가 가장 많이쓰는 탭이

Collection과 APIs이다.

Collection은 이름에서 보다시피 당연히 Request를 저장하는 곳이며

APIs는 API를 만드는 곳이다.

나는 위 2가지 메뉴를 제일 많이 쓴다.

물론 History도 쓰지만 엄청 많다고는 못하겠다.

 

History

To access the requests you've made, select History in the sidebar. When you're signed in to Postman, your history syncs across your devices.

Select a request to open it again in a new tab. To select more than one request, press and hold ⌘ or Ctrl, then select the requests.

Your history also includes collection runs. These remain as the summarized version of the run and aren't logged as single requests.

  • Select the add icon + to save the request to a collection.
  • Select the delete icon 
     to remove the request from your history.
  • Select the more actions icon 
     to access other actions, including creating a monitor, documentation, or mock server for the request.

Clearing your history

To remove all requests from your history, select the more actions icon 

 next to the History search bar, then select Clear all.

Saving responses in history

To save request responses in your history, select the more actions icon 

 next to the History search bar, then turn on Save Responses.

You can't use the Save Responses option with requests from Collection Runner.

 

 

다음은 메인 

사실 설명이 필요없다.

그냥 작업하는 공간이다.

감이 다 온다.

더보기

Main work area

Whether you're working with a collection, an API, or another element type, the center section of Postman is where you do the majority of your work. Tabs enable you to organize your work, while the right sidebar gives you access to element-specific tools like documentation, and the environment selector and environment quick look enable you to manage variables.

Tabs

Tabs allow you to organize and work between requests.

Opening a new tab

To open a new tab, select + in the middle of the screen.

You can also select ⌘+T or Ctrl+T to open a new tab.

If you open a request and don't edit or send it, then open another request, the second tab replaces the first tab. When the tab is in preview mode, it displays in italics.

You can set whether Postman opens requests in new tabs. Select the settings icon 

 to open Settings. Under Requests, select Always open requests in a new tab to turn this option on or off.

Saving or discarding changes

If a tab has unsaved changes, Postman displays a dot next to the tab name. Select 

 Save to save the changes. To close the tab and discard changes, select the close icon 

 then select Don't save.

Viewing conflicts

A tab will alert you to a conflict if you or a collaborator changes its contents in another tab or workspace. Postman prompts you to resolve any conflicts that happen.

Managing tabs

You can have many tabs open at the same time. To rearrange your open tabs, select and drag them in the desired order.

To manage your open tabs or to access recently closed tabs, select the more actions icon 

 to open a menu with action options:

  • Recently Closed Tabs - Shows tabs that you closed recently. Select one to reopen it.
  • Duplicate Selected Tab - (Desktop app only) Duplicates the current tab. This doesn't create a copy of the request, so when you duplicate a tab any edits you make are reflected in the original request.
  • Close Selected Tab - Closes the current tab. If the tab has unsaved changes, Postman asks if you want to save before closing.
  • Force Close Selected Tab - Closes the current tab without saving any changes.
  • Close All but Selected Tab - Closes all tabs except the one you're working in.
  • Close All Tabs - Closes all tabs. If any tabs contain unsaved changes, Postman will ask if you want to save before closing.
  • Force Close All Tabs - Closes all tabs without saving any changes.

You can also manage your open tabs or open a new tab by right-clicking on an existing tab.

Closing unsaved tabs. You can set whether Postman asks whether you want to save when you close a tab that has changes. Select the settings icon 

 to open Settings. Under Requests, select Always ask when closing unsaved tabs to turn this option on or off.

If you have a lot of tabs open, they might overflow the area of the tab bar. To go to tabs that are outside the viewable area, select the arrows to the left or right of the tab bar.

The right sidebar gives you access to more tools, including documentation, comments, code snippets, and request information, based on which kind of Postman element you select.

ToolAvailable forDescription
Documentation  Collections, requests See the documentation for a collection or for a specific request.
Comments  Collections, requests, APIs Leave comments on a specific part of a request or an API.
Code  Requests, APIs, history Generate code snippets in a variety of languages and frameworks that you can use in other apps.
Info  Collections, requests, APIs, environments, mock servers, monitors See details about the element, including its ID, when it was created, who created it, and more.
Related collections  Requests, history View public collections from the Public API Network that share the same base URL as your request and include API documentation.
Changelog  Collections, APIs Use the changelog to see changes that you and your collaborators have made. Available on Postman Basic, Professional, and Enterprise plans.
Pull requests  Collections, environments View any pull requests for a Postman element.
Forks  Collections, environments View any forks of a Postman element.
Activity feed  Monitors View the activity feed for a monitor.

Environment selector and environment quick look

The environment selector enables you to choose which environment to use in your work. Select an environment from the menu to set it as the active environment, which gives you access to the variables in that environment.

To check a variable value at a glance, use the quick look icon 

 

 

 

마지막은 Footer

얘도 딱히 뭐 별거 없다.

더보기

The footer on the bottom of Postman enables you to find and replace text, open the console, capture requests and cookies, open Bootcamp, and access several other tools.

  •  Hide sidebar - Close or reopen the sidebar.
  •  Sync status - See if you are connected to Postman's servers and your data is syncing.
  •  Find and replace - (Postman Desktop app only) Search the current workspace. You can also use the shortcuts ⌘+Shift+F or Ctrl+Shift+F. Enter your search string then select Find. Limit your search to a specific element type by selecting Collections, Environments, Globals, or Open tabs. To replace your search term in a selected element, select Replace in selected.
  •  Console - Inspect and debug your Postman requests.
  •  Cookies - View, manage, and sync cookies.
  •  Capture requests - Start a Postman proxy or Interceptor session.
  •  Bootcamp - Access an in-app classroom that teaches you how to use Postman, from the basics to advanced topics.
  •  Runner - Open the Collection Runner.
  •  Trash - Recover or permanently delete any deleted collections.
  •  Two-pane view - Toggle between a single pane view and a two pane view.
  •  Help - Access more resources, including release notes and Postman Support.

 

 


 

 

인터페이스에서 대충 알아보았고

진짜 쓰이는 내용은 다음부터 알아보려고 한다.

 

내가 쓰는 방법이지 모두가 쓰이는 것은 아니므로 참고만하자.

728x90
반응형
그리드형